Usage
Completed, Failed, or Canceled).
Event Types
| Event | Description |
|---|---|
status | Job status changed (Queued → Started, etc.) |
progress | Progress update for long-running jobs (e.g., “Processing sheet 3 of 12”) |
completed | Job finished successfully. Includes results. |
failed | Job encountered an error. Includes error. |
canceled | Job was canceled. |
Progress Events
Long-running jobs (like drawing preprocessing) emitprogress events:
progress field is a number between 0 and 1. Not all job types emit progress events.
Already-Completed Jobs
If the job has already completed when you open the stream, you’ll receive a single terminal event and the connection closes:Example: Python
Example: JavaScript
Heartbeat
The server sends a comment line every 15 seconds to keep the connection alive:Connection Limits
Each API key can have up to 10 concurrent SSE connections. Opening an 11th connection returns429 Too Many Requests.