Struct SquadsApi 

pub struct SquadsApi { /* private fields */ }

Squads — multi-agent groups that run a shared brief

Implementations

impl SquadsApi

pub async fn add_squad_graph_edge( &self, squad_id: &str, body: &AddSquadGraphEdgeRequest, ) -> Result<Map<String, Value>>

Add graph edge

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

POST /api/v1/squads/{squadId}/graph/edges

pub async fn add_squad_graph_node( &self, squad_id: &str, body: &AddSquadGraphNodeRequest, ) -> Result<Map<String, Value>>

Add graph node

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

POST /api/v1/squads/{squadId}/graph/nodes

pub async fn cancel_squad_run( &self, squad_id: &str, team_run_id: &str, ) -> Result<CancelSquadRunResponse>

Cancel a squad run

Stops the orchestration loop first, then every non-terminal child run, and releases the chat state so the canvas does not stay locked on a run that was just killed.

Order matters and is not an implementation detail: killing children while the loop is still running makes it spawn more — two fresh child runs were measured within two minutes of a “successful” cancel.

cancelledCount is camelCase on the wire, unlike every neighbouring field. That is what the server sends.

/api/v1/squads/* is the canonical surface; /api/v1/teams/* is the same handler under the older noun.

POST /api/v1/squads/{squadId}/runs/{teamRunId}/cancel

pub async fn create(&self, body: &TeamCreate) -> Result<Team>

Create a squad

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

POST /api/v1/squads

pub async fn delete(&self, squad_id: &str) -> Result<DeleteSquadResponse>

Delete squad

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

DELETE /api/v1/squads/{squadId}

pub async fn delete_squad_graph_edge( &self, squad_id: &str, edge_id: &str, ) -> Result<DeleteSquadGraphEdgeResponse>

Remove edge

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

DELETE /api/v1/squads/{squadId}/graph/edges/{edgeId}

pub async fn delete_squad_graph_node( &self, squad_id: &str, agent_id: &str, ) -> Result<DeleteSquadGraphNodeResponse>

Remove node

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

DELETE /api/v1/squads/{squadId}/graph/nodes/{agentId}

pub async fn get(&self, squad_id: &str) -> Result<Team>

Get squad

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}

pub async fn get_squad_chat_history( &self, squad_id: &str, params: &GetSquadChatHistoryParams, ) -> Result<GetSquadChatHistoryResponse>

Get squad chat history

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/chat

pub async fn get_squad_graph( &self, squad_id: &str, ) -> Result<GetSquadGraphResponse>

Get full squad graph

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/graph

pub async fn get_squad_graph_node( &self, squad_id: &str, agent_id: &str, ) -> Result<TeamGraphNode>

Get graph node

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/graph/nodes/{agentId}

pub async fn get_squad_run( &self, squad_id: &str, team_run_id: &str, ) -> Result<TeamRunDetail>

Get specific squad run

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/runs/{teamRunId}

pub async fn get_squad_run_messages( &self, squad_id: &str, team_run_id: &str, ) -> Result<GetSquadRunMessagesResponse>

Get squad run messages

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/runs/{teamRunId}/messages

pub async fn list(&self) -> Result<ListSquadsResponse>

List squads

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads

pub async fn list_squad_graph_edges( &self, squad_id: &str, ) -> Result<ListSquadGraphEdgesResponse>

List graph edges

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/graph/edges

pub async fn list_squad_graph_nodes( &self, squad_id: &str, ) -> Result<ListSquadGraphNodesResponse>

List graph nodes

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/graph/nodes

pub async fn list_squad_runs( &self, squad_id: &str, ) -> Result<ListSquadRunsResponse>

List runs for a squad

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/runs

pub async fn start_squad_run( &self, squad_id: &str, body: &StartSquadRunRequest, ) -> Result<StartSquadRunResponse>

Start a squad run

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

POST /api/v1/squads/{squadId}/runs

pub fn stream_squad_chat_events( &self, squad_id: &str, params: &StreamSquadChatEventsParams, ) -> EventStream

SSE stream for squad chat

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/chat/events

Required scopes: events:read.

Returns a server-sent event stream.

pub fn stream_squad_run_events( &self, squad_id: &str, run_id: &str, ) -> EventStream

Stream squad run events (SSE)

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

GET /api/v1/squads/{squadId}/runs/{runId}/events

Required scopes: events:read.

Returns a server-sent event stream.

pub async fn update(&self, squad_id: &str, body: &TeamUpdate) -> Result<Team>

Update squad

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

PUT /api/v1/squads/{squadId}

pub async fn update_squad_graph_node( &self, squad_id: &str, agent_id: &str, body: &UpdateSquadGraphNodeRequest, ) -> Result<Map<String, Value>>

Update graph node

/api/v1/squads/* is the canonical surface. /api/v1/teams/* is the same handler under the older noun: the server rewrites the leading path segment before dispatch, so the two are one endpoint and cannot drift apart.

PATCH /api/v1/squads/{squadId}/graph/nodes/{agentId}

Trait Implementations

impl Clone for SquadsApi

fn clone(&self) -> SquadsApi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SquadsApi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.