API Reference

View as Markdown

View as Markdown

Copy Markdown

---

Open in Claude

Open in ChatGPT

Groups

List Groups

get/v1/groups/

Create Group

post/v1/groups/

Retrieve Group

get/v1/groups/{group_id}

Update Group

patch/v1/groups/{group_id}

Delete Group

delete/v1/groups/{group_id}

ModelsExpand Collapse

DynamicManager = object { manager_agent_id, manager_type, max_turns, termination_token }

manager_agent_id: string

manager_type: optional "dynamic"

Accepts one of the following:

"dynamic"

max_turns: optional number

termination_token: optional string

Group = object { id, agent_ids, description, 15 more }

id: string

The id of the group. Assigned by the database.

agent_ids: array of string

description: string

manager_type: ManagerType

Accepts one of the following:

"round_robin"

"supervisor"

"dynamic"

"sleeptime"

"voice_sleeptime"

"swarm"

base_template_id: optional string

The base template id.

deployment_id: optional string

The id of the deployment.

hidden: optional boolean

If set to True, the group will be hidden.

last_processed_message_id: optional string

manager_agent_id: optional string

max_message_buffer_length: optional number

The desired maximum length of messages in the context window of the convo agent. This is a best effort, and may be off slightly due to user/assistant interleaving.

max_turns: optional number

min_message_buffer_length: optional number

The desired minimum length of messages in the context window of the convo agent. This is a best effort, and may be off-by-one due to user/assistant interleaving.

project_id: optional string

The associated project id.

Deprecatedshared_block_ids: optional array of string

sleeptime_agent_frequency: optional number

template_id: optional string

The id of the template.

termination_token: optional string

turns_counter: optional number

ManagerType = "round_robin" or "supervisor" or "dynamic" or 3 more

Accepts one of the following:

"round_robin"

"supervisor"

"dynamic"

"sleeptime"

"voice_sleeptime"

"swarm"

RoundRobinManager = object { manager_type, max_turns }

manager_type: optional "round_robin"

Accepts one of the following:

"round_robin"

max_turns: optional number

SleeptimeManager = object { manager_agent_id, manager_type, sleeptime_agent_frequency }

manager_agent_id: string

manager_type: optional "sleeptime"

Accepts one of the following:

"sleeptime"

sleeptime_agent_frequency: optional number

SupervisorManager = object { manager_agent_id, manager_type }

manager_agent_id: string

manager_type: optional "supervisor"

Accepts one of the following:

"supervisor"

VoiceSleeptimeManager = object { manager_agent_id, manager_type, max_message_buffer_length, min_message_buffer_length }

manager_agent_id: string

manager_type: optional "voice_sleeptime"

Accepts one of the following:

"voice_sleeptime"

max_message_buffer_length: optional number

The desired maximum length of messages in the context window of the convo agent. This is a best effort, and may be off slightly due to user/assistant interleaving.

min_message_buffer_length: optional number

The desired minimum length of messages in the context window of the convo agent. This is a best effort, and may be off-by-one due to user/assistant interleaving.

GroupsMessages

Create Group Message

post/v1/groups/{group_id}/messages

List Group Messages

get/v1/groups/{group_id}/messages

Create Group Message Streaming

post/v1/groups/{group_id}/messages/stream

Update Group Message

patch/v1/groups/{group_id}/messages/{message_id}

Reset Group Messages

patch/v1/groups/{group_id}/reset-messages