> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stream execution output via SSE

> Server-sent event stream. Events carry JSON payloads: {type: 'stdout'|'stderr', data}, {type: 'truncated', output_truncated: true}, {type: 'error', error,…

<Warning>
  **Confirm your deployment before running this request.** This page describes an API contract;
  a published reference does not establish hosted availability. Check the dated
  [host report](/api-reference/hosts) and obtain your deployment URL and credentials.
  Replace the example host if your provisioned service uses a different URL.
</Warning>

### Path parameters

<ParamField path="id" type="string (uuid)" required>
  Sandbox identifier
</ParamField>

<ParamField path="executionId" type="string" required>
  Execution identifier
</ParamField>

### Response

Returns `text/event-stream` — Server-sent event stream. Events carry JSON payloads: `&#123;type: 'stdout'|'stderr', data&#125;`, `&#123;type: 'truncated', output_truncated: true&#125;`, `&#123;type: 'error', error, code?&#125;`, `&#123;type: 'exit', code, output_truncated?&#125;`, then `&#123;type: 'done'&#125;`. Each event has an SSE `id` (`&lt;executionId>` plus a sequence number); send it as `Last-Event-ID` (header or `last_event_id` query parameter) to resume after the last event you saw. `: heartbeat` comments are written every 20s while the execution runs. Completed executions replay a synthesized terminal sequence.

### Status codes

| Code | Meaning | |
| - | - | - |
| `200` | Server-sent event stream. Events carry JSON payloads: \`\{type: 'stdout' | 'stderr', data}`, `\{type: 'truncated', output\_truncated: true}`, `\{type: 'error', error, code?}`, `\{type: 'exit', code, output\_truncated?}`, then `\{type: 'done'}`. Each event has an SSE `id` (`\<executionId>`plus a sequence number); send it as`Last-Event-ID`(header or`last\_event\_id`query parameter) to resume after the last event you saw.`: heartbeat\` comments are written every 20s while the execution runs. Completed executions replay a synthesized terminal sequence. |

### Using this contract

Read the [source OpenAPI document](/spec/sandbox.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

<RequestExample>
  ```bash cURL theme={null}
  curl --silent --show-error --fail-with-body --no-buffer --request GET \
    --url 'https://api.sandbox.stateset.app/api/v1/sandbox/{id}/executions/{executionId}/stream' \
    --header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  "string"
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.