Skip to main content
GET
Stream reconnectable durable-run events
Stream ordered Praxa run events over SSE, persist the numeric cursor, and resume safely after a disconnect.
Availability: Production partner preview. Required scope: runs:read.

Authenticate safely

Create a disposable personal workspace API key with exactly runs:read. Send it as Authorization: Bearer $PRAXA_API_KEY. A Gateway OAuth token, Supabase JWT, provider credential, or organization memory key is not interchangeable with this key. The hosted playground sends the credential from your browser session to the documented API through the configured playground proxy. Use test data, never share the key, and revoke it when the check ends.

Request fields

string
required
id path parameter.
integer
Resume strictly after this task_run_events sequence.

Runnable request examples

What success means

A 200 response opens an SSE stream. Completion is proven only by a terminal event or authoritative run readback.

Successful response

200 — SSE frames include matching numeric id and payload sequence. Comment heartbeats may appear. During uncertain-outcome reconciliation, the run remains non-terminal and keeps the stream open. A completed, failed, or cancelled run closes it.

Handle failures

Example problem

Verify the result

  1. Require each event id to match its payload sequence.
  2. Reconnect with Last-Event-ID and reject sequence regression.
  3. Treat EOF before a terminal event as incomplete.

Retry, cleanup, and production use

  • Treat 401, 403, and 409 as authority or state signals, not generic retry prompts.
  • For 429 or retryable 5xx responses, follow server retry guidance and keep a bounded attempt budget.
  • Move the request into a trusted application backend before production; never ship the Praxa key in browser or mobile code.
  • Revoke the disposable key, disable test webhooks, and erase disposable candidate data after validation.
Continue with API authentication, the failure and retry guide, and the end-to-end coverage matrix.
Last modified on August 14, 2026