Skip to main content
PATCH
/
api
/
v1
/
agents
/
{agent_id}
Update Agent
curl --request PATCH \
  --url https://control-plane.kubiya.ai/api/v1/agents/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "system_prompt": "<string>",
  "status": "<string>",
  "capabilities": [
    "<unknown>"
  ],
  "configuration": {},
  "state": {},
  "model_id": "<string>",
  "model": "<string>",
  "llm_config": {},
  "runtime": "<string>",
  "runner_name": "<string>",
  "team_id": "<string>",
  "environment_ids": [
    "<string>"
  ],
  "skill_ids": [
    "<string>"
  ],
  "skill_configurations": {},
  "execution_environment": {
    "working_dir": "<string>",
    "env_vars": {},
    "secrets": [
      "<string>"
    ],
    "integration_ids": [
      "<string>"
    ],
    "mcp_servers": {}
  }
}
'
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "system_prompt": "<string>",
  "status": "<string>",
  "capabilities": [
    "<unknown>"
  ],
  "configuration": {},
  "model_id": "<string>",
  "llm_config": {},
  "runtime": "<string>",
  "runner_name": "<string>",
  "team_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "last_active_at": "<string>",
  "state": {},
  "error_message": "<string>",
  "projects": [
    {}
  ],
  "environments": [
    {}
  ],
  "skill_ids": [
    "<string>"
  ],
  "skills": [
    {}
  ],
  "execution_environment": {
    "working_dir": "<string>",
    "env_vars": {},
    "secrets": [
      "<string>"
    ],
    "integration_ids": [
      "<string>"
    ],
    "mcp_servers": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kubiya.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Enter your Kubiya API token (format: Bearer )

Path Parameters

​
agent_id
string
required

Body

application/json
​
name
string | null
​
description
string | null
​
system_prompt
string | null
​
status
string | null
​
capabilities
any[] | null
​
configuration
Configuration · object
​
state
State · object
​
model_id
string | null
​
model
string | null
​
llm_config
Llm Config · object
​
runtime
string | null
​
runner_name
string | null
​
team_id
string | null
​
environment_ids
string[] | null
​
skill_ids
string[] | null
​
skill_configurations
Skill Configurations · object
​
execution_environment
ExecutionEnvironment · object

Execution environment configuration for agents/teams

Response

Successful Response

​
id
string
required
​
organization_id
string
required
​
name
string
required
​
description
string | null
required
​
system_prompt
string | null
required
​
status
string
required
​
capabilities
any[]
required
​
configuration
Configuration · object
required
​
model_id
string | null
required
​
llm_config
Llm Config · object
required
​
runtime
string | null
required
​
runner_name
string | null
required
​
team_id
string | null
required
​
created_at
string
required
​
updated_at
string
required
​
last_active_at
string | null
required
​
state
State · object
required
​
error_message
string | null
required
​
projects
Projects · object[]

Projects this agent belongs to

​
environments
Environments · object[]

Environments this agent is deployed to

​
skill_ids
string[] | null

IDs of associated skills

​
skills
Skills · object[] | null

Associated skills with details

​
execution_environment
ExecutionEnvironment · object

Execution environment configuration for agents/teams