Update user agent

curl --request PATCH \
  --url https://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_tools": [
    {
      "command_template": "<string>",
      "description": "<string>",
      "id": "<string>",
      "input_schema": {},
      "is_executable": true,
      "script_content": "<string>",
      "script_path": "<string>",
      "timeout_seconds": 123
    }
  ],
  "description": "<string>",
  "expected_config_version": 2,
  "install_commands": [
    "<string>"
  ],
  "is_dynamic": true,
  "name": "<string>",
  "native_tools": [
    "<string>"
  ],
  "prereq_packages": [
    "<string>"
  ],
  "require_env_vars": [
    "<string>"
  ],
  "system_context": "<string>",
  "tags": [
    "<string>"
  ],
  "verify_commands": [
    "<string>"
  ],
  "when_to_use": "<string>"
}
'

import requests

url = "https://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id}"

payload = {
    "custom_tools": [
        {
            "command_template": "<string>",
            "description": "<string>",
            "id": "<string>",
            "input_schema": {},
            "is_executable": True,
            "script_content": "<string>",
            "script_path": "<string>",
            "timeout_seconds": 123
        }
    ],
    "description": "<string>",
    "expected_config_version": 2,
    "install_commands": ["<string>"],
    "is_dynamic": True,
    "name": "<string>",
    "native_tools": ["<string>"],
    "prereq_packages": ["<string>"],
    "require_env_vars": ["<string>"],
    "system_context": "<string>",
    "tags": ["<string>"],
    "verify_commands": ["<string>"],
    "when_to_use": "<string>"
}
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({
    custom_tools: [
      {
        command_template: '<string>',
        description: '<string>',
        id: '<string>',
        input_schema: {},
        is_executable: true,
        script_content: '<string>',
        script_path: '<string>',
        timeout_seconds: 123
      }
    ],
    description: '<string>',
    expected_config_version: 2,
    install_commands: ['<string>'],
    is_dynamic: true,
    name: '<string>',
    native_tools: ['<string>'],
    prereq_packages: ['<string>'],
    require_env_vars: ['<string>'],
    system_context: '<string>',
    tags: ['<string>'],
    verify_commands: ['<string>'],
    when_to_use: '<string>'
  })
};

fetch('https://neo.api.projectdiscovery.io/api/v1/agents/user/{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://neo.api.projectdiscovery.io/api/v1/agents/user/{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([
    'custom_tools' => [
        [
                'command_template' => '<string>',
                'description' => '<string>',
                'id' => '<string>',
                'input_schema' => [
                                
                ],
                'is_executable' => true,
                'script_content' => '<string>',
                'script_path' => '<string>',
                'timeout_seconds' => 123
        ]
    ],
    'description' => '<string>',
    'expected_config_version' => 2,
    'install_commands' => [
        '<string>'
    ],
    'is_dynamic' => true,
    'name' => '<string>',
    'native_tools' => [
        '<string>'
    ],
    'prereq_packages' => [
        '<string>'
    ],
    'require_env_vars' => [
        '<string>'
    ],
    'system_context' => '<string>',
    'tags' => [
        '<string>'
    ],
    'verify_commands' => [
        '<string>'
    ],
    'when_to_use' => '<string>'
  ]),
  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://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id}"

	payload := strings.NewReader("{\n  \"custom_tools\": [\n    {\n      \"command_template\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": \"<string>\",\n      \"input_schema\": {},\n      \"is_executable\": true,\n      \"script_content\": \"<string>\",\n      \"script_path\": \"<string>\",\n      \"timeout_seconds\": 123\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expected_config_version\": 2,\n  \"install_commands\": [\n    \"<string>\"\n  ],\n  \"is_dynamic\": true,\n  \"name\": \"<string>\",\n  \"native_tools\": [\n    \"<string>\"\n  ],\n  \"prereq_packages\": [\n    \"<string>\"\n  ],\n  \"require_env_vars\": [\n    \"<string>\"\n  ],\n  \"system_context\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"verify_commands\": [\n    \"<string>\"\n  ],\n  \"when_to_use\": \"<string>\"\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://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_tools\": [\n    {\n      \"command_template\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": \"<string>\",\n      \"input_schema\": {},\n      \"is_executable\": true,\n      \"script_content\": \"<string>\",\n      \"script_path\": \"<string>\",\n      \"timeout_seconds\": 123\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expected_config_version\": 2,\n  \"install_commands\": [\n    \"<string>\"\n  ],\n  \"is_dynamic\": true,\n  \"name\": \"<string>\",\n  \"native_tools\": [\n    \"<string>\"\n  ],\n  \"prereq_packages\": [\n    \"<string>\"\n  ],\n  \"require_env_vars\": [\n    \"<string>\"\n  ],\n  \"system_context\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"verify_commands\": [\n    \"<string>\"\n  ],\n  \"when_to_use\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://neo.api.projectdiscovery.io/api/v1/agents/user/{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  \"custom_tools\": [\n    {\n      \"command_template\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": \"<string>\",\n      \"input_schema\": {},\n      \"is_executable\": true,\n      \"script_content\": \"<string>\",\n      \"script_path\": \"<string>\",\n      \"timeout_seconds\": 123\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expected_config_version\": 2,\n  \"install_commands\": [\n    \"<string>\"\n  ],\n  \"is_dynamic\": true,\n  \"name\": \"<string>\",\n  \"native_tools\": [\n    \"<string>\"\n  ],\n  \"prereq_packages\": [\n    \"<string>\"\n  ],\n  \"require_env_vars\": [\n    \"<string>\"\n  ],\n  \"system_context\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"verify_commands\": [\n    \"<string>\"\n  ],\n  \"when_to_use\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "has_dynamic_tools": true,
  "has_memory": true,
  "id": "<string>",
  "name": "<string>",
  "tools_count": 123,
  "type": "user",
  "attached_toolkits": [
    {
      "attached_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": {
        "username": "<string>"
      },
      "provided_by_editor": true,
      "shared_with_team": true,
      "tool_count": 123,
      "toolkit_id": "<string>",
      "visible_to_viewer": true,
      "description": "<string>"
    }
  ],
  "attached_tools": [
    {
      "attached_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": {
        "username": "<string>"
      },
      "provided_by_editor": true,
      "shared_with_team": true,
      "tool_id": "<string>",
      "toolkit": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "toolkit_id": "<string>"
      },
      "visible_to_viewer": true,
      "description": "<string>"
    }
  ],
  "can_edit": true,
  "config_hash": "<string>",
  "config_version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "custom_tools": [
    {
      "commandTemplate": "<string>",
      "description": "<string>",
      "id": "<string>",
      "inputSchema": {},
      "isExecutable": true,
      "scriptContent": "<string>",
      "scriptPath": "<string>",
      "timeoutSeconds": 123
    }
  ],
  "custom_tools_count": 123,
  "dependencies": {
    "secrets": [
      {
        "name": "<string>",
        "state": "shared",
        "note": "<string>"
      }
    ],
    "toolkits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "owner": {
          "username": "<string>"
        },
        "provided_by_editor": true,
        "state": "shared",
        "toolkit_id": "<string>",
        "credential_mode": "personal",
        "note": "<string>"
      }
    ]
  },
  "edit_access": "owner",
  "editor_count": 123,
  "fork_count": 123,
  "has_installation_requirements": true,
  "install_commands": [
    "<string>"
  ],
  "is_owned": true,
  "native_tools": [
    "<string>"
  ],
  "original_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner": {
    "username": "<string>"
  },
  "prereq_packages": [
    "<string>"
  ],
  "published_at": "2023-11-07T05:31:56Z",
  "require_env_vars": [
    "<string>"
  ],
  "system_context": "<string>",
  "tags": [
    "<string>"
  ],
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": {
    "username": "<string>"
  },
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "verify_commands": [
    "<string>"
  ],
  "visibility": "public",
  "when_to_use": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

Agents

Update user agent

Update a custom agent you own, or a team-shared agent whose owner gave you edit access (address it by UUID). Every update that changes a value increments config_version and records a version in the agent’s history; a body that changes nothing returns the agent unchanged. Send expected_config_version to reject the update with 409 when someone else changed the agent since you read it. Only the owner may change is_dynamic and the execution fields (install_commands, verify_commands, prereq_packages, custom_tools, require_env_vars). Teammates pick up the change on their next run.

PATCH

api

agents

user

{agent_id}

Update user agent

curl --request PATCH \
  --url https://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "custom_tools": [
    {
      "command_template": "<string>",
      "description": "<string>",
      "id": "<string>",
      "input_schema": {},
      "is_executable": true,
      "script_content": "<string>",
      "script_path": "<string>",
      "timeout_seconds": 123
    }
  ],
  "description": "<string>",
  "expected_config_version": 2,
  "install_commands": [
    "<string>"
  ],
  "is_dynamic": true,
  "name": "<string>",
  "native_tools": [
    "<string>"
  ],
  "prereq_packages": [
    "<string>"
  ],
  "require_env_vars": [
    "<string>"
  ],
  "system_context": "<string>",
  "tags": [
    "<string>"
  ],
  "verify_commands": [
    "<string>"
  ],
  "when_to_use": "<string>"
}
'

import requests

url = "https://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id}"

payload = {
    "custom_tools": [
        {
            "command_template": "<string>",
            "description": "<string>",
            "id": "<string>",
            "input_schema": {},
            "is_executable": True,
            "script_content": "<string>",
            "script_path": "<string>",
            "timeout_seconds": 123
        }
    ],
    "description": "<string>",
    "expected_config_version": 2,
    "install_commands": ["<string>"],
    "is_dynamic": True,
    "name": "<string>",
    "native_tools": ["<string>"],
    "prereq_packages": ["<string>"],
    "require_env_vars": ["<string>"],
    "system_context": "<string>",
    "tags": ["<string>"],
    "verify_commands": ["<string>"],
    "when_to_use": "<string>"
}
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({
    custom_tools: [
      {
        command_template: '<string>',
        description: '<string>',
        id: '<string>',
        input_schema: {},
        is_executable: true,
        script_content: '<string>',
        script_path: '<string>',
        timeout_seconds: 123
      }
    ],
    description: '<string>',
    expected_config_version: 2,
    install_commands: ['<string>'],
    is_dynamic: true,
    name: '<string>',
    native_tools: ['<string>'],
    prereq_packages: ['<string>'],
    require_env_vars: ['<string>'],
    system_context: '<string>',
    tags: ['<string>'],
    verify_commands: ['<string>'],
    when_to_use: '<string>'
  })
};

fetch('https://neo.api.projectdiscovery.io/api/v1/agents/user/{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://neo.api.projectdiscovery.io/api/v1/agents/user/{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([
    'custom_tools' => [
        [
                'command_template' => '<string>',
                'description' => '<string>',
                'id' => '<string>',
                'input_schema' => [
                                
                ],
                'is_executable' => true,
                'script_content' => '<string>',
                'script_path' => '<string>',
                'timeout_seconds' => 123
        ]
    ],
    'description' => '<string>',
    'expected_config_version' => 2,
    'install_commands' => [
        '<string>'
    ],
    'is_dynamic' => true,
    'name' => '<string>',
    'native_tools' => [
        '<string>'
    ],
    'prereq_packages' => [
        '<string>'
    ],
    'require_env_vars' => [
        '<string>'
    ],
    'system_context' => '<string>',
    'tags' => [
        '<string>'
    ],
    'verify_commands' => [
        '<string>'
    ],
    'when_to_use' => '<string>'
  ]),
  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://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id}"

	payload := strings.NewReader("{\n  \"custom_tools\": [\n    {\n      \"command_template\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": \"<string>\",\n      \"input_schema\": {},\n      \"is_executable\": true,\n      \"script_content\": \"<string>\",\n      \"script_path\": \"<string>\",\n      \"timeout_seconds\": 123\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expected_config_version\": 2,\n  \"install_commands\": [\n    \"<string>\"\n  ],\n  \"is_dynamic\": true,\n  \"name\": \"<string>\",\n  \"native_tools\": [\n    \"<string>\"\n  ],\n  \"prereq_packages\": [\n    \"<string>\"\n  ],\n  \"require_env_vars\": [\n    \"<string>\"\n  ],\n  \"system_context\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"verify_commands\": [\n    \"<string>\"\n  ],\n  \"when_to_use\": \"<string>\"\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://neo.api.projectdiscovery.io/api/v1/agents/user/{agent_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_tools\": [\n    {\n      \"command_template\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": \"<string>\",\n      \"input_schema\": {},\n      \"is_executable\": true,\n      \"script_content\": \"<string>\",\n      \"script_path\": \"<string>\",\n      \"timeout_seconds\": 123\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expected_config_version\": 2,\n  \"install_commands\": [\n    \"<string>\"\n  ],\n  \"is_dynamic\": true,\n  \"name\": \"<string>\",\n  \"native_tools\": [\n    \"<string>\"\n  ],\n  \"prereq_packages\": [\n    \"<string>\"\n  ],\n  \"require_env_vars\": [\n    \"<string>\"\n  ],\n  \"system_context\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"verify_commands\": [\n    \"<string>\"\n  ],\n  \"when_to_use\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://neo.api.projectdiscovery.io/api/v1/agents/user/{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  \"custom_tools\": [\n    {\n      \"command_template\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": \"<string>\",\n      \"input_schema\": {},\n      \"is_executable\": true,\n      \"script_content\": \"<string>\",\n      \"script_path\": \"<string>\",\n      \"timeout_seconds\": 123\n    }\n  ],\n  \"description\": \"<string>\",\n  \"expected_config_version\": 2,\n  \"install_commands\": [\n    \"<string>\"\n  ],\n  \"is_dynamic\": true,\n  \"name\": \"<string>\",\n  \"native_tools\": [\n    \"<string>\"\n  ],\n  \"prereq_packages\": [\n    \"<string>\"\n  ],\n  \"require_env_vars\": [\n    \"<string>\"\n  ],\n  \"system_context\": \"<string>\",\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"verify_commands\": [\n    \"<string>\"\n  ],\n  \"when_to_use\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "has_dynamic_tools": true,
  "has_memory": true,
  "id": "<string>",
  "name": "<string>",
  "tools_count": 123,
  "type": "user",
  "attached_toolkits": [
    {
      "attached_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": {
        "username": "<string>"
      },
      "provided_by_editor": true,
      "shared_with_team": true,
      "tool_count": 123,
      "toolkit_id": "<string>",
      "visible_to_viewer": true,
      "description": "<string>"
    }
  ],
  "attached_tools": [
    {
      "attached_at": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "owner": {
        "username": "<string>"
      },
      "provided_by_editor": true,
      "shared_with_team": true,
      "tool_id": "<string>",
      "toolkit": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "toolkit_id": "<string>"
      },
      "visible_to_viewer": true,
      "description": "<string>"
    }
  ],
  "can_edit": true,
  "config_hash": "<string>",
  "config_version": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "custom_tools": [
    {
      "commandTemplate": "<string>",
      "description": "<string>",
      "id": "<string>",
      "inputSchema": {},
      "isExecutable": true,
      "scriptContent": "<string>",
      "scriptPath": "<string>",
      "timeoutSeconds": 123
    }
  ],
  "custom_tools_count": 123,
  "dependencies": {
    "secrets": [
      {
        "name": "<string>",
        "state": "shared",
        "note": "<string>"
      }
    ],
    "toolkits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "owner": {
          "username": "<string>"
        },
        "provided_by_editor": true,
        "state": "shared",
        "toolkit_id": "<string>",
        "credential_mode": "personal",
        "note": "<string>"
      }
    ]
  },
  "edit_access": "owner",
  "editor_count": 123,
  "fork_count": 123,
  "has_installation_requirements": true,
  "install_commands": [
    "<string>"
  ],
  "is_owned": true,
  "native_tools": [
    "<string>"
  ],
  "original_agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner": {
    "username": "<string>"
  },
  "prereq_packages": [
    "<string>"
  ],
  "published_at": "2023-11-07T05:31:56Z",
  "require_env_vars": [
    "<string>"
  ],
  "system_context": "<string>",
  "tags": [
    "<string>"
  ],
  "team_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": {
    "username": "<string>"
  },
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "verify_commands": [
    "<string>"
  ],
  "visibility": "public",
  "when_to_use": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

{
  "error": "Bad request",
  "code": "user_spending_cap_reached",
  "error_id": "<string>",
  "kind": "forbidden request",
  "message": "<string>",
  "param": "<string>",
  "turnstile_site_key": "<string>"
}

Authorizations

Authorization

string

header

required

JWT authentication token

Path Parameters

agent_id

string

required

Your own agent's ID (kebab-case slug), or the UUID of a custom agent: one you own, or a team-shared agent you can run (the id GET /api/v1/agents returns for it).

Body

application/json

Only fields whose value differs from the agent's current value count as changes; a body with no change returns the agent without recording a version. A teammate with edit access (not the owner) may not change is_dynamic, install_commands or verify_commands (the setup commands run on every run with the runner's secrets in the environment); resending their current values is allowed. custom_tools, prereq_packages and require_env_vars are editable by anyone with edit access.

custom_tools

object[]

Show child attributes

description

string

expected_config_version

integer

Optimistic concurrency check: the config_version you last read. When it is no longer current the update is rejected with 409 agent_version_conflict. Omit to update unconditionally.

Required range: x >= 1

install_commands

string[]

is_dynamic

boolean

name

string

native_tools

string[]

prereq_packages

string[]

require_env_vars

string[]

system_context

string

Response

Agent updated

description

string

required

has_dynamic_tools

boolean

required

has_memory

boolean

required

string

required

Agent ID for user access (use with /agents/user/{agent_id})

name

string

required

tools_count

integer

required

type

enum<string>

required

Available options:

user

attached_toolkits

object[]

Dynamic toolkits attached to this agent (soft-deleted ones excluded). Filled on GET and PATCH of a single agent; omitted on list, create and visibility responses.

Show child attributes

attached_tools

object[]

Single dynamic tools attached to this agent (soft-deleted tools and tools of soft-deleted toolkits excluded). Filled on GET and PATCH of a single agent; omitted on list, create and visibility responses.

Show child attributes

can_edit

boolean

Whether the caller may edit this agent: always for the owner; for a team-shared agent, when its owner gave the caller edit access.

config_hash

string

config_version

integer

created_at

string<date-time>

custom_tools

object[]

Show child attributes

custom_tools_count

integer

dependencies

object

What sharing this agent with its team shared or took back: its required secrets and attached toolkits. Present only on the visibility PATCH response; GET /api/v1/agents/user/{agent_id}/dependencies reads it at any time.

Show child attributes

edit_access

enum<string>

Who besides the owner may edit a team-shared agent: owner nobody; team every active team admin or member; members the named editors. Viewers never edit.

Available options:

owner,

team,

members

editor_count

integer

Number of named editors. 0 unless edit_access is members. Omitted on list responses for an agent whose edit_access is members; GET the agent for the count.

fork_count

integer

has_installation_requirements

boolean

install_commands

string[]

is_owned

boolean

Whether the caller owns this agent.

native_tools

string[]

original_agent_id

string<uuid>

owner

object

Show child attributes

prereq_packages

string[]

published_at

string<date-time>

require_env_vars

string[]

system_context

string