ExecutionsResource on the Figranium JavaScript SDK gives you full visibility and control over every task run. Use it to list past executions, inspect a single run, clean up history, stop active runs, and subscribe to a live Server-Sent Events stream of execution updates.
Methods
list
list
GET /api/executions/list, which is the route intended for API-key access. If you pass apiKeyRoute: false, the SDK switches to GET /api/executions instead.Most callers should leave
apiKeyRoute at its default (true). Only override it when your deployment requires the alternate route.get
get
GET /api/executions/:id. You can supply a generic type parameter to narrow the typed result field.delete
delete
DELETE /api/executions/:id.clear
clear
POST /api/executions/clear.stop
stop
POST /api/executions/stop.stream
stream
GET /api/executions/stream and yields each event as it arrives. The iterable stays open until the server closes the stream, the client stops iterating, or the request is aborted.For details on the StreamEvent shape and how cancellation works, see Streaming. For error handling, see Errors.