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": {}
  }
}
'
import requests

url = "https://control-plane.kubiya.ai/api/v1/agents/{agent_id}"

payload = {
"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": {}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: {}
}
})
};

fetch('https://control-plane.kubiya.ai/api/v1/agents/{agent_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://control-plane.kubiya.ai/api/v1/agents/{agent_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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' => [

]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://control-plane.kubiya.ai/api/v1/agents/{agent_id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"status\": \"<string>\",\n \"capabilities\": [\n \"<unknown>\"\n ],\n \"configuration\": {},\n \"state\": {},\n \"model_id\": \"<string>\",\n \"model\": \"<string>\",\n \"llm_config\": {},\n \"runtime\": \"<string>\",\n \"runner_name\": \"<string>\",\n \"team_id\": \"<string>\",\n \"environment_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"skill_configurations\": {},\n \"execution_environment\": {\n \"working_dir\": \"<string>\",\n \"env_vars\": {},\n \"secrets\": [\n \"<string>\"\n ],\n \"integration_ids\": [\n \"<string>\"\n ],\n \"mcp_servers\": {}\n }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://control-plane.kubiya.ai/api/v1/agents/{agent_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"status\": \"<string>\",\n \"capabilities\": [\n \"<unknown>\"\n ],\n \"configuration\": {},\n \"state\": {},\n \"model_id\": \"<string>\",\n \"model\": \"<string>\",\n \"llm_config\": {},\n \"runtime\": \"<string>\",\n \"runner_name\": \"<string>\",\n \"team_id\": \"<string>\",\n \"environment_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"skill_configurations\": {},\n \"execution_environment\": {\n \"working_dir\": \"<string>\",\n \"env_vars\": {},\n \"secrets\": [\n \"<string>\"\n ],\n \"integration_ids\": [\n \"<string>\"\n ],\n \"mcp_servers\": {}\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://control-plane.kubiya.ai/api/v1/agents/{agent_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"status\": \"<string>\",\n \"capabilities\": [\n \"<unknown>\"\n ],\n \"configuration\": {},\n \"state\": {},\n \"model_id\": \"<string>\",\n \"model\": \"<string>\",\n \"llm_config\": {},\n \"runtime\": \"<string>\",\n \"runner_name\": \"<string>\",\n \"team_id\": \"<string>\",\n \"environment_ids\": [\n \"<string>\"\n ],\n \"skill_ids\": [\n \"<string>\"\n ],\n \"skill_configurations\": {},\n \"execution_environment\": {\n \"working_dir\": \"<string>\",\n \"env_vars\": {},\n \"secrets\": [\n \"<string>\"\n ],\n \"integration_ids\": [\n \"<string>\"\n ],\n \"mcp_servers\": {}\n }\n}"

response = http.request(request)
puts response.read_body
{
  "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": {}
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

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 | null
state
State · object | null
model_id
string | null
model
string | null
llm_config
Llm Config · object | null
runtime
string | null
runner_name
string | null
team_id
string | null
environment_ids
string[] | null
skill_ids
string[] | null
skill_configurations
Skill Configurations · object | null
execution_environment
ExecutionEnvironment · object | null

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 | null

Execution environment configuration for agents/teams