Stream a run
Server-sent events: one per step (a user's message is a message step, sent when the model receives it), {type:"thought", text, at} as soon as the model's reply arrives (before its tool runs; the same text is that step's thought), {type:"status", status, by?, reason?} on pause and resume, {type:"exec", command, at} when a shell command starts and {type:"output", stream, data} while it runs, and a final {type:"done", status, result, resultText, error, errorCode, resumable}. Stays open while the run is paused.
/v1/agent/runs/{id}/events/streamRequest
| Method and path | GET/v1/agent/runs/{id}/events/stream |
|---|---|
| Base URL | https://api.boxline.dev |
| Authentication | Your API key in the x-api-key header (or Authorization: Bearer). The examples read it from BOXLINE_API_KEY. |
Path parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
idrequired | string | – | – |
curl -N "https://api.boxline.dev/v1/agent/runs/$RUN_ID/events/stream" \ -H "x-api-key: $BOXLINE_API_KEY"import { Boxline } from "@boxline/sdk";const bx = new Boxline(); // reads BOXLINE_API_KEY and BOXLINE_API_URLfor await (const event of bx.agent.stream("RUN_ID")) { console.log(event.type, event);} // ends after the "done" eventfrom boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLfor event in bx.agent.stream("RUN_ID"): print(event["type"], event) # ends after the "done" eventResponses
200 OK
An event stream.
text/event-stream: Server-sent events, sent as they happen.
Server-sent events, sent as they happenErrors
Errors have a matching HTTP status and the same body. code is stable, so check it in your code; message is for people. See Errors and request ids.
| Status | Codes | When |
|---|---|---|
| 401 Unauthorized | unauthorized | Missing or invalid API key. |
| 404 Not Found | not_found, invite_not_found, provider_unavailable | No such thing in this project (or organization), or no such route. |
{ "error": { "code": "not_found", "message": "session not found", "requestId": "req_4fJx0aQm2Lk9Pz7N" }}Learn more
These docs describe a beta API. Endpoints, fields and SDK methods may change before general availability; breaking changes will be listed in the changelog.