Stream session events
Server-sent events, one Event per data: line; first the backlog after after, then live.
GET
/v1/sessions/{id}/events/streamRequest
| Method and path | GET/v1/sessions/{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 | – | – |
Query parameters
| Name | Type | Default | Allowed values | Description |
|---|---|---|---|---|
after | integer | 0 | – | |
runId | string | – | – | Only the events an agent run caused in this session (those whose data.runId is this run id). |
curl -N "https://api.boxline.dev/v1/sessions/$SESSION_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 e of bx.sessions.streamEvents("SESSION_ID")) { console.log(e.seq, e.type, e.text ?? e.url ?? "");}from boxline import Boxlinebx = Boxline() # reads BOXLINE_API_KEY and BOXLINE_API_URLfor e in bx.sessions.stream_events("SESSION_ID"): print(e["seq"], e["type"], e.get("text") or e.get("url", ""))Responses
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.