Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

Secret key (sk_live_...)

Path Parameters

agent_id
string
required

Unique identifier for the agent (prefixed with agt_).

Body

Request body for updating an agent. Only include fields you want to change.

name
null | string

Updated display name.

description
null | string

Updated description.

Response

OK

An agent object. Agents organize related tasks under a single use case.

id
string
required

Unique identifier for the agent, prefixed with agt_.

object
string
required

Always agent.

name
string
required

Display name for the agent.

description
null | string
required

Description of the agent's purpose.

tasks
object[]
required

Tasks associated with this agent.

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created.

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated.

request_id
string
required

Unique identifier for the API request. Include this when contacting support.