Agents

Update, suspend, or resume an agent

JWT callers must be organization admins. API keys require agents:manage. Status and accompanying fields commit atomically; machine callers cannot delegate beyond their own scopes and provider-bound agents retain their provider scope ceiling.

patch/agents/{agentId}

Request

  • Base URL: https://app.arkova.ai/api/v1
  • URL: https://app.arkova.ai/api/v1/agents/{agentId}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key
    • HTTP bearer

Request body

namestring
descriptionstring
allowed_scopesstring[]
status'active' | 'suspended'
frameworkstring
versionstring
callback_urlstring uri nullable

Response

Agent updated

idstring uuid required
namestring required
descriptionstring nullable
agent_typestring required
status'active' | 'suspended' | 'revoked' required
allowed_scopesstring[] required
frameworkstring nullable
versionstring nullable
callback_urlstring uri nullable
metadataobject nullable
last_active_atstring date-time nullable

When an API key bound to this agent last authenticated (observed at authentication, throttled to about once a minute). Not a statement about what the request did.

Changes

No recorded changes to this operation across all 1 revision of this API.