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

Authorization
string
required
Bearer token. Example: Bearer agd_live_xxxxxxxxxxxxxxxxxxxx
Content-Type
string
required
Must be application/json

Path Parameters

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

Body Parameters

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

Response

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

Examples

Response

Errors