Skip to main content
POST
Create 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.

Body

application/json
name
string
required

Display name of the agent.

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

Added to the agent's system prompt. At most 30000 characters.

Maximum string length: 30000
scope
enum<string>
default:private

private: only the owner sees the agent. organization: every member does. Defaults to private.

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

What the agent can use. A capability you omit gets its default. capabilities.memory sets the agent's memory namespace.

execution_options
ChatExecutionOptions · object | null
deprecated

Deprecated. Use capabilities instead.

allow_execution_options_override
boolean
default:false

Leave it false. Legacy, tied to execution_options.

model_ids
string[] | null

Model chain, in failover order, from GET /agents/models. At least one id. Omit it to use the organization's default chain.

Minimum array length: 1
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