EdgazeDocsEdgaze Docs
DocumentationAPI Reference
Home
Getting started
API ReferenceAuthenticationQuickstart
Workflows
GETList WorkflowsGETGet WorkflowGETList Workflow VersionsPOSTAccept Workflow Update
Runs
POSTCreate RunGETList RunsGETGet RunPOSTCancel RunGETList Run Events
Guides
WebhooksErrors & Edge CasesBilling & Spend CapsStreaming & Real-timeOpenAPI specification

Platform status

Checking platform status
All documentation
API Reference

REST endpoints, authentication, and webhooks for running workflows from your backend.

Overview
Getting started
API ReferenceAuthenticationQuickstart
Workflows
GETList WorkflowsGETGet WorkflowGETList Workflow VersionsPOSTAccept Workflow Update
Runs
POSTCreate RunGETList RunsGETGet RunPOSTCancel RunGETList Run Events
Guides
WebhooksErrors & Edge CasesBilling & Spend CapsStreaming & Real-timeOpenAPI specification
Developer console

Platform status

Checking platform status
Runs

Get Run

Poll canonical run status, failure reason, buyer-facing charge, and final outputs.

curl --fail-with-body --silent --show-error 'https://api.edgaze.ai/v1/runs/7c9e6679-7425-40de-944b-e07fc1f90ae7' \
  -H "Authorization: Bearer $EDGAZE_API_KEY"
Audience

Developers polling an asynchronous run.

GEThttps://api.edgaze.ai/v1/runs/{run_id}

Overview#

Poll this endpoint after POST /runs to track execution. The response includes canonical status, a sanitized reason for failures, buyer-facing charge (displayedChargeUsd), explicit billingStatus, and final outputs once the run completes.

billingStatus is pending while a paid run is not financially final, settled when displayedChargeUsd is final, and not_charged when a terminal run produced no charge. New successful runs publish status: "completed" only after billing settlement commits. The pending terminal combination remains documented so clients can recognize and safely poll older or reconciled runs.

Runs are scoped to the API key owner. You only see runs started by keys belonging to the same account: cross-tenant ids return 404, not 403.

Poll every 1-3s until status is completed, failed, or cancelled and billingStatus is settled or not_charged. On success, read outputs and displayedChargeUsd. On failure, inspect reason.

Authorization#

run:read

Parameters#

Headers

Authorizationstringheaderrequired

Bearer token with run:read scope.

Example: Bearer edgaze_sk_live_…

Path parameters

run_idstringpathrequired

UUID returned from POST /runs.

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

Response#

Example payloads are in the request/response panel above.

Edge cases#

Cross-tenant isolation404not_found

Runs belong to the API key owner. Requesting another user's run ID returns 404, not 403.

Displayed charge only

displayedChargeUsd is the buyer-facing price. Raw compute cost is never exposed via the API.

Billing finality

billingStatus is pending until settlement, settled when displayedChargeUsd is final, or not_charged for terminal runs without a charge. Poll a terminal pending response until billing is final.

Terminal states

Poll until status is completed, failed, or cancelled. Provider and orchestration timeouts are reported as failed with a safe reason.

Was this useful?

Your response helps us improve the documentation.

← List RunsCancel Run →
On this page
OverviewAuthorizationParametersResponseEdge cases
© 2026 Edge Platforms, Inc. All rights reserved.