Inspect

Update agent

Partially update a custom agent. The API key user must be the creator, a contributor, or an Inspect admin. Only provided fields are changed.

Base URL
PATCH
/api/public/v1/agents/{agent_id}

Partially update a custom agent. The API key user must be the creator, a contributor, or an Inspect admin. Only provided fields are changed.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key authentication. Use your API key as the bearer token.

Path Parameters

agent_id*string

Agent ID

Request Body

application/json
  1. body

At least one field must be provided.

Properties1 <= properties
name?string

Display name of the agent. Leading and trailing whitespace is trimmed.

Length1 <= length <= 100
description?string

Description of what this agent does

prompt?|

System prompt, or null to clear it

Lengthlength <= 100000
model?|

Preferred model, or null to use the default. Any string up to 200 characters is stored; it is not checked against the model list.

Lengthlength <= 200
skills?array<>|

Configured skill names, or null for no explicit skill list

capabilities?|

Capability overrides, or null to restore defaults

prompt_context_mode?Agents.PromptContextMode

Whether the custom prompt appends to or replaces the base system prompt

Value in"append""replace"
repositories?array<>|

Workspace allowlist containing configured workspace IDs; null means unrestricted

repo_hint?|

Optional default repository hint

Lengthlength <= 500

Response Body

Custom agent updated

application/json
  1. response
data*

Full agent configuration for a single ID. Includes fields not present on the list-agents response.

Example Request
curl -X PATCH 'https://your-org.inspect.com/api/public/v1/agents/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "data": {    "prompt": "string",    "created_by": "string",    "skills": [      "string"    ],    "capabilities": {      "edit": true,      "git_write": true,      "browser": true,      "user_skills": true,      "repo_skills": true,      "datadog": true,      "customer_data_access": true,      "notion": true,      "inspect_sessions": true,      "web_search": true,      "artifacts": true,      "tools": {},      "linear": true,      "feature_flags": true,      "zendesk": true,      "sentry": true,      "deepwiki": true    },    "prompt_context_mode": "append",    "repositories": [      "string"    ],    "repo_hint": "string",    "id": "string",    "name": "string",    "description": "string",    "model": "string",    "is_builtin": true,    "created_at": "2019-08-24T14:15:22Z"  }}