Skip to main content
PUT
/
api
/
v1
/
agents
/
{id}
/
status
Update agent status
curl --request PUT \
  --url https://api.example.com/api/v1/agents/{id}/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "draft"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "engine_config": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "draft",
  "version": "<string>",
  "base_url": "<string>",
  "resources": {
    "memory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sso_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "guardrail_ids": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "position": "input",
        "sort_order": 0
      }
    ],
    "mcp_server_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "observability_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "integration_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  }
}

Headers

​
x-workspace-id
string | null

Path Parameters

​
id
string
required

Body

application/json

Schema for updating only the agent status.

​
status
enum<string>
required

New agent status

Available options:
draft,
active,
inactive,
deprecated,
error

Response

Successful Response

Complete managed agent model for responses.

​
id
string<uuid>
required
​
name
string
required
​
engine_config
Engine Config · object
required

Materialized EngineConfig (full assembled config)

​
created_at
string<date-time>
required

Creation timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
status
enum<string>
default:draft

Agent status

Available options:
draft,
active,
inactive,
deprecated,
error
​
version
string | null

Agent version

​
base_url
string | null

Base URL

​
resources
AgentResourceIds · object

Resource references (FK/junction)

Last modified on March 22, 2026