Skip to main content
PUT
Update an agent

Authorizations

x-cominty-token
string
header
required

A Cominty Platform API secret. A key created now starts with sk-cmt-. Send it as is, or as Bearer sk-cmt-..., with at most one Bearer prefix. A key created before the prefix existed has no sk-cmt- and still works.

Path Parameters

agent_pid
string
required

Identifier of the agent.

Body

application/json
name
string | null

New name. Omit it to leave the name unchanged.

description
string | null
Maximum string length: 500
instructions
string | null

New instructions, at most 30000 characters. null clears them.

Maximum string length: 30000
scope
enum<string> | null

private or organization.

Available options:
organization,
private
capabilities
AgentCapabilities · object | null

Merged capability by capability: each one you send replaces the stored one, the others stay. null clears them all.

execution_options
ChatExecutionOptions · object | null
deprecated

Deprecated. Use capabilities instead.

allow_execution_options_override
boolean | null

Legacy, tied to execution_options.

memory_namespace
string | null
deprecated

Deprecated. Use capabilities.memory instead.

Required string length: 1 - 128

Response

Successful Response

id
string
required
name
string
required
description
string | null
required
capabilities
AgentCapabilities · object | null
required
execution_options
Execution Options · object | null
required
memory_namespace
string | null
required
managed
boolean
required
scope
string
required
owner
string
required
instructions
string | null
required
allow_execution_options_override
boolean
required
models
LLMModelSummaryOut · object[]
required