Sign in
AgentService
Agents

Update an agent

Updates an agent in the workspace

patch/v1/workspaces/{workspaceId}/agents/{id}

Path parameters

workspaceIdstring required

Workspace ID.

idstring required

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

Request body

workspaceIdstring

Workspace ID.

idstring

Agent ID. Accepts the canonical agent_… form or the external_id:<value> form.

updateMaskstring field-mask

Fields to update

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_DRAFT' | 'STATE_PUBLISHED' | 'STATE_ARCHIVED' enum required

The current lifecycle state of the agent. Output only. Agents are created in STATE_DRAFT; use the :publish, :unpublish, :archive, and :unarchive actions to transition between states.

Changes