Squads

get

Retrieves multiple squads.

Query parameters
agentIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

joinsany ofOptionalDefault: []
or
string · enumOptionalPossible values:
pageNumbernumber · min: 1Optional

The page number.

Default: 1
pageSizenumber · min: 1 · max: 100Optional

The page size.

Default: 10
referenceIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

searchstring · min: 1Optional

Search term to filter squads by name or description.

versionIdsany ofOptionalDefault: []
string · uuid[]Optional

A UUID v4 string that identifies an entity.

or
string · uuidOptional

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves all squads for the workspace.

application/json
or
get
/api/v1/squads
post

Creates a new squad.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the squad.

modestring · enumRequired

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

Possible values:
namestring · min: 3 · max: 50Required

The display name of the squad.

picturestring · nullableRequired

The picture associated with the squad.

Responses
200

The squad was created.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired
versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the squad.

modestring · enumRequired

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

Possible values:
namestring · min: 3 · max: 50Required

The display name of the squad.

picturestring · nullableRequired

The picture associated with the squad.

superIdentityIdstring · uuidRequired

The super identity ID associated with the squad.

workspaceIdstring · uuidRequired

The workspace ID that owns the squad.

post
/api/v1/squads
post

Creates a new agent or attaches an existing one to a squad.

Path parameters
squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
or
Responses
200

The agent was created.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

typestring · enumRequiredPossible values:
post
/api/v1/squads/{squadId}/agents
post

Executes a squad with provided messages.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
contextstringOptional
Responses
200

The squad was executed.

application/json
attachmentsUrlsstring[]Required
contentany ofRequired
stringOptional
or
post
/api/v1/squads/{id}/execute
get

Retrieves a squad.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves a squad.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired
versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the squad.

modestring · enumRequired

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

Possible values:
namestring · min: 3 · max: 50Required

The display name of the squad.

picturestring · nullableRequired

The picture associated with the squad.

superIdentityIdstring · uuidRequired

The super identity ID associated with the squad.

workspaceIdstring · uuidRequired

The workspace ID that owns the squad.

get
/api/v1/squads/{id}
delete

Removes a squad.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The squad was removed.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/squads/{id}
patch

Updates a squad.

Path parameters
idstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
descriptionstring · min: 3 · max: 250 · nullableOptional

The internal description of the squad.

modestring · enumOptional

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

Possible values:
namestring · min: 3 · max: 50Optional

The display name of the squad.

picturestring · nullableOptional

The picture associated with the squad.

superIdentityIdstring · uuidOptional

The super identity ID associated with the squad.

Responses
200

The squad was updated.

application/json
createdAtstring · date-timeRequired
idstring · uuidRequired

A UUID v4 string that identifies an entity.

isRemovedbooleanRequired
referenceIdstring · uuid · nullableRequired

The ID of the original entity in production.

updatedAtstring · date-timeRequired
versionIdstring · uuidRequired

A UUID v4 string that identifies an entity.

descriptionstring · min: 3 · max: 250 · nullableRequired

The internal description of the squad.

modestring · enumRequired

The management mode. In flat, agents redirect the chat to one another. In hierarchical, all iterations are intermediated by the manager.

Possible values:
namestring · min: 3 · max: 50Required

The display name of the squad.

picturestring · nullableRequired

The picture associated with the squad.

superIdentityIdstring · uuidRequired

The super identity ID associated with the squad.

workspaceIdstring · uuidRequired

The workspace ID that owns the squad.

patch
/api/v1/squads/{id}
get

Retrieves agents in a squad.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

Retrieves a squad agent.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

typestring · enumRequiredPossible values:
get
/api/v1/squads/{squadId}/agents/{agentId}
delete

Detaches an agent from a squad.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Responses
200

The squad agent relationship was removed.

application/json
messagestringRequired

An informative message for a call that has no effective result to be returned.

delete
/api/v1/squads/{squadId}/agents/{agentId}
patch

Updates agents in a squad.

Path parameters
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

Header parameters
authorizationstringRequired

The API key to use for authentication. Can be created in the api keys section on the workspace settings page.

Body
typestring · enumOptionalPossible values:
Responses
200

The squad agent was updated.

application/json
createdAtstring · date-timeRequired
updatedAtstring · date-timeRequired
agentIdstring · uuidRequired

A UUID v4 string that identifies an entity.

squadIdstring · uuidRequired

A UUID v4 string that identifies an entity.

typestring · enumRequiredPossible values:
patch
/api/v1/squads/{squadId}/agents/{agentId}

Last updated