ExecutionsResource: List, Inspect, and Stream Runs

list

HTTP endpoint: GET /api/executions/list (default) or GET /api/executions
Signature: func list(apiKeyRoute: Bool = true, options: RequestOptions = .init()) async throws -> [Execution]

Returns a list of executions. By default it calls 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.

list_executions.swift

// Default route: GET /api/executions/list
let executions = try await client.executions.list()
print(executions.first?.runId ?? "", executions.first?.status ?? "")

// Alternate route: GET /api/executions
let altExecutions = try await client.executions.list(apiKeyRoute: false)

get

HTTP endpoint: GET /api/executions/{id}
Signature: func get(_ id: String, options: RequestOptions = .init()) async throws -> Execution

Fetches a single execution by its ID.

get_execution.swift

let execution = try await client.executions.get("exec_01JXYZ")
print(execution.status ?? "", execution.durationMs ?? 0)

delete

HTTP endpoint: DELETE /api/executions/{id}
Signature: func delete(_ id: String, options: RequestOptions = .init()) async throws -> JSONObject

Removes a single execution record.

delete_execution.swift

let result = try await client.executions.delete("exec_01JXYZ")

clear

HTTP endpoint: POST /api/executions/clear
Signature: func clear(options: RequestOptions = .init()) async throws -> JSONObject

Deletes all executions in bulk.

clear_executions.swift

let result = try await client.executions.clear()

stop

HTTP endpoint: POST /api/executions/stop
Signature: func stop(runID: String, options: RequestOptions = .init()) async throws -> JSONObject

Sends a stop signal to an active run.

stop_execution.swift

let result = try await client.executions.stop(runID: "run_abc123")

stream

HTTP endpoint: GET /api/executions/stream
Signature: func stream(options: RequestOptions = .init()) -> AsyncThrowingStream<StreamEvent<JSONValue>, Error>

Opens a Server-Sent Events connection and yields each event as it arrives. The stream stays open until the server closes the connection, the consumer stops iterating, or the request is aborted. The stream sends only accept and auth headers, not default or per-call headers, and uses options.timeout.For details on the StreamEvent shape and how cancellation works, see Streaming. For error handling, see Errors.

stream_executions.swift

do {
    for try await event in client.executions.stream(options: .init(timeout: 60)) {
        print(event.event ?? "", event.data)
    }
} catch let error as FigraniumError {
    // FigraniumError with code "REQUEST_ABORTED" when timed out
    print(error)
}

Cancelling the consuming Swift.Task cancels the stream.

watch

HTTP endpoint: GET /api/executions/{id} (polled)
Signature: func watch(_ executionID: String, interval: Duration = .seconds(1), options: RequestOptions = .init()) -> AsyncThrowingStream<Execution, Error>

Polls get at the given interval and yields an Execution only when the status changes. The stream finishes automatically when the execution reaches an outcome or status of success, error, stopped, crashed, or anti_bot. Cancelling the consuming Swift.Task cancels the polling loop.

watch_execution.swift

for try await execution in client.executions.watch("exec_01JXYZ", interval: .seconds(2)) {
    print(execution.status ?? "unknown")
}

JavaScript SDK

Python SDK

Swift SDK

ExecutionsResource: List, Inspect, and Stream Runs

Methods

End-to-end example

​Methods

​End-to-end example

Methods

End-to-end example