SIsignalshq
CPA CHAT

Send a CPA chat message and receive Server-Sent Events as the turn progresses.

Stream the agent's thinking as Server-Sent Events.

Event types (each data: line is a JSON object with a type field):

  • iteration — top of each agent loop iteration: {iteration, max_iterations}
  • progress — tool dispatch started: {tool, stage, tool_use_id}
  • tool_complete — tool finished: {tool, status, elapsed_ms, tool_use_id}
  • text_delta — assistant text token: {text}
  • done — turn done; carries cumulative {usage}
  • result — terminal payload (full SendMessageResponse shape)
  • error — turn failed; carries {message}

The browser opens an EventSource and renders each event as it arrives.

post/internal/api/cpa-chat/messages/stream

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Request body

client_idstring uuid required
tax_yearinteger
messagestring required

Free-text user message.

selected_option_idstring nullable

When the prior turn was a ClarificationRequest, the id of the option the CPA picked. Mutually compatible with message (free-text addendum).

expected_clarification_versioninteger nullable

Monotonic clarification version the client expects to resolve. If the server's version is higher, another caller (e.g. second browser tab) already resolved the pending clarification — the router returns 409 StaleClarificationReply.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.