Runs

Get run

Read the run's canonical status, sanitized failure reason, buyer-facing displayed charge, and outputs. Rate limiting: reads are not metered per-key today — only POST /runs is (60/minute). Reads may become metered without a breaking change, so treat 429 with Retry-After as possible on any endpoint and back off rather than polling in a tight loop. For run progress prefer GET /runs/{id}/stream, or poll GET /runs/{id} no more than once per second.

get/runs/{id}

Request

  • Base URL: https://api.edgaze.ai/v1
  • URL: https://api.edgaze.ai/v1/runs/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

UUID returned from POST /runs.

Example:7c9e6679-7425-40de-944b-e07fc1f90ae7

Response

Run detail.

idstring uuid required
status'pending' | 'running' | 'suspended' | 'completed' | 'failed' | 'cancelled' required

Canonical run status exposed by the public API.

reasonstring nullable required

Buyer-safe failure explanation. Non-null only when status is failed; provider-specific detail is deliberately generalized.

suspendedboolean required

True exactly when status is suspended; kept as a separate flag so a caller can test for 'waiting' without matching on the status enum. A run suspends for one of two reasons, reported as reason on the run.suspended event: wait_timer (a delay node) resumes itself when the timer fires, while wait_signal (the workflow needs credentials) waits for the buyer to supply them on the web run page. The API cannot resume a run; POST /runs/{id}/cancel is the only way for an API caller to end one early.

workflowIdstring uuid nullable required
workflowVersionIdstring uuid nullable required
startedAtstring date-time nullable required
completedAtstring date-time nullable required
displayedChargeUsdnumber nullable required

Buyer-facing charge. null until the run settles. USD amount as a JSON number with up to six decimal places. Preserve the documented precision and do not round intermediate calculations to two decimal places.

billingStatus'pending' | 'settled' | 'not_charged' required

Whether the buyer-facing charge for this run is still pending, finalized, or not applicable.

outcome'completed' | 'completed_with_issues' nullable required

Set when status is completed, null otherwise. completed: every step finished. completed_with_issues: the run returned its outputs but some steps failed; it is charged for the completed steps' compute only, without the creator's price.

Changes

No recorded changes to this operation across all 1 revision of this API.