Browse the api reference

Stream Operation Events

get/v1/operations/{operation_id}/stream

Server-Sent Events stream for real-time operation progress. Use from_sequence to replay missed events on reconnect. Max 5 concurrent SSE connections per user. Consumes no credits.

Authentication

Authenticate in any one of these ways — not all of them:

API key in the X-API-Key header.
Bearer token in the Authorization header.

Path parameters

Name	Type	Description
`operation_id`required	string	Operation identifier from initial submission Constraints: matches `^(op_[0-9A-Z]{26}\|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$`

Query parameters

Name Type Description

Name	Type	Description
`from_sequence`optional	integer	Replay stored events from this sequence number, then stream live ones. A running operation replays nothing at 0 (live events only); a settled one replays its history from here (0 = all) and closes. Default: `0` Constraints: at least 0
`token`optional	string	JWT token for SSE authentication

from_sequenceoptional

integer

Replay stored events from this sequence number, then stream live ones. A running operation replays nothing at 0 (live events only); a settled one replays its history from here (0 = all) and closes.

Default: 0

Constraints: at least 0

tokenoptional string JWT token for SSE authentication

Header parameters

Name	Type	Description
`authorization`optional	string	Authorization

Example request

curl

curl -X GET "https://api.robosystems.ai/v1/operations/{operation_id}/stream" \
  -H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
  -H "authorization: <authorization>"

Responses

200 SSE stream — Content-Type: text/event-stream

Response

"string"

Status	Meaning
400	Invalid request
401	Authentication required
403	Access denied
404	Resource not found
422	Validation Error
429	Rate limit exceeded
500	Internal server error