Skip to main content
GET
/
threads
/
{thread_id}
/
runs
/
{run_id}
/
stream
Join Run Stream
curl --request GET \
  --url https://api.example.com/threads/{thread_id}/runs/{run_id}/stream
"<string>"

Documentation Index

Fetch the complete documentation index at: https://docs.langchain.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Last-Event-ID
string

The ID of the last event received. Set to -1 if you want to stream all events. Requires stream_resumable=true to be set when creating the run.

Path Parameters

​
thread_id
string<uuid>
required

The ID of the thread.

​
run_id
string<uuid>
required

The ID of the run.

Query Parameters

​
stream_mode
string

The mode to stream the run in. If not provided, the default mode will be used.

​
cancel_on_disconnect
boolean
default:false

If true, the run will be cancelled if the client disconnects.

Response

Success

The server will send a stream of events in SSE format.

Example event:

id: 1

event: message

data: {}