Skip to main content
PATCH
Update an installed agent's version or settings

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). Discovery: https://api.guild.ai/.well-known/oauth-authorization-server.

Path Parameters

workspace_agent_id
string<uuid>
required

Body

application/json
should_autoupdate
boolean | null

Move to each new published version automatically

is_default_chat_agent
boolean | null
new_version_id
string<uuid> | null

Agent version to run, one of the agent's published versions

required_credentials_mode
enum<string> | null

Whose credentials an agent may run with.

SHARED admits only org-side credentials; MEMBER admits only the acting member's own, plus a credential dedicated to the agent, which is scoped to the agent under either mode. Unset means no requirement, and the resolution ladder decides on its own.

Available options:
SHARED,
MEMBER

Response

Successful response

id
string<uuid>
created_at
string<date-time>
updated_at
string<date-time>
creator_id
string<uuid>

The user or API key that added this agent version to the workspace.

version_id
string<uuid>
workspace_id
string<uuid>
is_default_chat_agent
boolean

If True, this workspace agent is used for new chat sessions when no explicit agent is provided.

should_autoupdate
boolean

If True, the agent will automatically update when a new version is published.

archived_at
string<date-time> | null
archived_by_id
string<uuid> | null
profile_name
string | null

Set when this install is an MCP gateway profile, addressed as /workspaces//mcp/<profile_name>. Unset on ordinary agent installs.

Maximum string length: 100
required_credentials_mode
enum<string> | null

Whose credentials this agent may run with: SHARED = only org-side credentials serve, MEMBER = only the acting member's own. Unset = the workspace's declaration applies, and no requirement when that is unset too.

Available options:
SHARED,
MEMBER
agent
object
agent_version
object
creator
object
workspace
object