Skip to content

Chat API

The Chat API provides direct access to Squad’s intelligence engine through REST endpoints with real-time SSE streaming.

Endpoints

MethodEndpointDescription
POST/api/v1/chatCreate a new chat session (rate limited: 60/min)
POST/api/v1/chat/{session_id}/messageSend a message (rate limited: 30/min)
GET/api/v1/chat/{session_id}/streamSSE event stream for real-time progress
GET/api/v1/chat/{session_id}/eventsHistorical event trace for a session
GET/api/v1/chat/{session_id}/statusSession status
POST/api/v1/chat/{session_id}/disambiguateSend disambiguation response
POST/api/v1/chat/{session_id}/reviewSubmit review response
GET/api/v1/chat/{session_id}/historyGet session message history
GET/api/v1/chat/historyList all chat sessions

Live Stream vs Historical Events

  • /stream delivers Server-Sent Events in real time as AIM processes a query. Connect when you send a message and listen for progress updates.
  • /events returns the full event trace for a session after processing completes. Use this to replay or inspect what happened during a previous interaction.

Next Steps