Workflows

Get Workflow

Retrieve a single workflow with input schema, access state, pricing, and an example run request.

curl -X GET 'https://api.edgaze.ai/v1/workflows/550e8400-e29b-41d4-a716-446655440000' \
  -H 'Authorization: Bearer edgaze_sk_live_YOUR_KEY'

GEThttps://api.edgaze.ai/v1/workflows/{workflow_id}

Overview#

Fetch full detail for one workflow, including the `inputSchema` you need to build a POST /runs body. The response also tells you whether the key holder can run the workflow now (`apiRunnableNow`), what it costs (`displayedRunPriceUsd`), and includes a ready-made `exampleRequest`.

Use this after listing workflows when you need schemas for a specific id, or when your integration caches workflow metadata and refreshes a single listing on demand.

GET /workflows/{workflow_id} before the first production run of a workflow. Check apiRunnableNow and purchaseRequired before calling POST /runs. Map inputSchema fields to your inputs object: both name and nodeId keys are accepted.

Authorization#

run:readrun:execute

Parameters#

Headers

Authorizationstringheaderrequired

Bearer token with your secret API key.

Example: Bearer edgaze_sk_live_…

Path parameters

workflow_idstringpathrequired

UUID of the workflow.

Example: 550e8400-e29b-41d4-a716-446655440000

Response#

Example success and error payloads are in the request/response panel above.

Edge cases#

Non-leaky access denial403forbidden

A 403 forbidden is returned when you lack entitlement. A 404 is returned only when the workflow ID does not exist.

Input key aliases

When starting a run, inputs accept both the input name (topic) and the nodeId (input_1) as keys.

Purchase required

Legacy unlock workflows return purchaseRequired: true and apiRunnableNow: false until unlocked.