Streaming

Stream text response via SSE

Streams Claude CLI output using Server-Sent Events (SSE). Provides real-time streaming of Claude's response with session management and usage tracking. Event types: session (session ID), text (streaming content), result (final usage stats), error (errors), done (stream complete).

post/stream

Request body

systemstring
promptstring required
sessionIdstring
modelstring
allowedToolsstring[]

Response

SSE stream with real-time Claude CLI output

Changes

Changed in 4 of the 7 revisions of this API.44

  • f7074f1efbee11See the full diff
    • added the new NO_TOOLS_AVAILABLE enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new optional request property allowedTools

      new-optional-request-property

    • removed the request property userEmail

      request-property-removed

    • added the new CONCURRENCY_LIMIT_ERROR enum value to the code response property for the response status 400

      response-property-enum-value-added

  • 62c4085e0ca013See the full diff
    • removed the request property allowedTools

      request-property-removed

    • added the new optional request property userEmail

      new-optional-request-property

    • removed the CONCURRENCY_LIMIT_ERROR enum value from the code response property for the response status 400

      response-property-enum-value-removed

    • removed the NO_TOOLS_AVAILABLE enum value from the code response property for the response status 400

      response-property-enum-value-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog