Skip to main content
The Executions API lets you inspect and manage the lifecycle of Figranium runs. Query history, retrieve full results for large payloads, stop queued or running executions, and stream live updates over SSE. All endpoints accept either a signed-in session cookie or an API key. See Get Your Figranium API Key and API Scopes for authentication setup.

List executions (API key)

GET /api/executions/list

Returns a lightweight list of execution records with summary metadata without full logs or result payloads. Use this for dashboard views and history listings when you don’t need per-execution detail. Requires API-key authentication. Response:

List executions (session)

GET /api/executions

Lists execution history using session authentication. Response:

Get an execution

GET /api/executions/:id

Gets detailed logs and the result for a specific execution. Accepts an API key or a signed-in session. If the stored record exceeded MAX_PERSISTED_EXECUTION_BYTES (default 256 KB), the result in the history record is trimmed and marked with "truncated": true and "hasFullResult": true. Use GET /api/executions/:id/result to load the complete result. Response:
Error responses:

Get full result

GET /api/executions/:id/result

Returns the complete stored result for an execution whose history record was trimmed because it exceeded MAX_PERSISTED_EXECUTION_BYTES (default 256 KB). Trimmed records have result.hasFullResult set to true. Accepts a session or an API key. Full results are deleted together with execution history when the retention period expires. See Captures and Storage for retention behavior. Response:
Error responses:

Stop an execution

POST /api/executions/stop

Stops a running execution, or cancels a run that is still waiting in the execution queue. If the run is still queued, it is cancelled before it starts, and the original run request responds with 200:
Body:
Response:
Error responses: If the client that started a queued run disconnects before the run starts, Figranium cancels the queued run automatically.

Stream live updates

GET /api/executions/stream?runId=<runId>

Opens a server-sent events (SSE) stream of live execution updates for a specific run. Use this for real-time dashboards or interfaces that show a task’s progress without repeatedly polling the full execution record. Query parameters: The stream returns text/event-stream events as the execution progresses. Connect with an SSE-compatible client and process events as they arrive. Error responses:

Clear all execution history

POST /api/executions/clear

Clears all execution history records. This operation cannot be undone. Response:
Error responses:

Delete an execution

DELETE /api/executions/:id

Deletes a single execution record by ID. Response:
Error responses:

Execution schema

The Execution object returned by list and detail endpoints contains the following fields:

REST API Reference

Browse the full endpoint reference for tasks, schedules, settings, and more.

Get Your API Key

Create and copy an API key for your instance.

API Scopes

Choose least-privileged permissions for integrations.