agentsGroups

List Agent Groups

Lists the groups for an agent

Authentication

AuthorizationBearer

Header authentication of the form Bearer <token>

Path parameters

agent_idstringRequiredformat: "^agent-[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"=42 characters

The ID of the agent in the format ‘agent-<uuid4>’

Query parameters

manager_typestring or nullOptional
Manager type to filter groups by
beforestring or nullOptional
Group ID cursor for pagination. Returns groups that come before this group ID in the specified sort order
afterstring or nullOptional
Group ID cursor for pagination. Returns groups that come after this group ID in the specified sort order
limitinteger or nullOptionalDefaults to 100
Maximum number of groups to return
orderenumOptionalDefaults to desc
Sort order for groups by creation time. 'asc' for oldest first, 'desc' for newest first
Allowed values:
order_by"created_at"Optional
Field to sort by

Response

Successful Response
idstring
The id of the group. Assigned by the database.
manager_typeenum
agent_idslist of strings
descriptionstring
project_idstring or null
The associated project id.
template_idstring or null
The id of the template.
base_template_idstring or null
The base template id.
deployment_idstring or null
The id of the deployment.
shared_block_idslist of strings or null
manager_agent_idstring or null
termination_tokenstring or null
max_turnsinteger or null
sleeptime_agent_frequencyinteger or null
turns_counterinteger or null
last_processed_message_idstring or null
max_message_buffer_lengthinteger or null

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_lengthinteger or null

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.

hiddenboolean or null
If set to True, the group will be hidden.

Errors