Quickstart

From zero to a completed API run in four steps. You need a Developer account and an API key with both `run:execute` and `run:read` scopes.

Create an API key#

Open Developer → API keys and create a key. Copy the plaintext immediately: it will not be shown again. Optionally set a spend cap and window to limit exposure during testing.

Export the key as an environment variable:

export EDGAZE_API_KEY=edgaze_sk_live_…

List workflows#

Discover workflows your key can access. Each item includes id, title, and whether it is runnable now.

curl '$EDGAZE_API_BASE/workflows' \
  -H 'Authorization: Bearer $EDGAZE_API_KEY'

Replace `$EDGAZE_API_BASE` with your base URL.

Start a run#

Pick a workflow id from the list response. Map your inputs to the schema from `GET /workflows/{id}`. A 202 response includes `run.id` and `statusUrl`.

curl -X POST '$EDGAZE_API_BASE/runs' \
  -H 'Authorization: Bearer $EDGAZE_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"workflow":"<workflow_id>","inputs":{"topic":"Hello"}}'

Poll until complete#

Poll every 1-3 seconds until status reaches a terminal state. On success, read outputs from the response. Handle 402 spend cap and 429 rate limit at request time; wallet failures may appear asynchronously as `status: failed`.

curl '$EDGAZE_API_BASE/runs/<run_id>' \
  -H 'Authorization: Bearer $EDGAZE_API_KEY'

See Create Run for edge cases and Webhooks to skip polling in production.