streams
get/api/v1/threads/{threadId}/stream

Request

  • Base URL
    https://api.capy.ai
  • Auth
    HTTP bearer

Path parameters

threadIdstring required

Query parameters

afterstring

Exclusive event-ID cursor to start the committed lane after; the Last-Event-ID header wins when both are present.

untilstring

run: close the stream with done after the run in progress ends, or at once when the thread is not working.

framesstring

subagent: send each subagent's lifecycle as a subagent frame. Defaults to task, the original task frame.

Headers

last-event-idstring

The last id: a client read; the committed lane resumes after it.

Response

Success

Changes

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • info

      added to the response body anyOf list for the response status

    • info

      added the new optional query request parameter frames

    • info

      added subschema #7 to the response body anyOf list for the response status