Skip to main content
PATCH
Update Agent
Update one or more fields on an existing agent. Only the fields you include in the request body will be changed.

Request

Headers

string
required
Bearer token. Example: Bearer agd_live_xxxxxxxxxxxxxxxxxxxx
string
required
Must be application/json

Path Parameters

string
required
The agent’s UUID. Example: 550e8400-e29b-41d4-a716-446655440000

Body Parameters

string
Human-readable name for the agent.
string
Description of what this agent does.
string
Reserved for a future release. Webhooks are not yet available on standard plans.
string
Framework type. One of: custom, langchain, crewai, autogen, mastra, n8n.
object
Custom metadata object. Replaces existing metadata entirely.

Response

Returns the full updated agent object.
string
Internal UUID for this agent record.
string
The unique slug identifier.
string
Updated name.
string
Updated description.
string
Reserved field. Currently unused on standard plans.
string
Updated framework type.
string
Current connection status.
object
Updated metadata.
string
ISO 8601 creation timestamp.

Examples

Response

Errors