Workflows

Get Workflow

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

curl --fail-with-body --silent --show-error 'https://api.edgaze.ai/v1/workflows/550e8400-e29b-41d4-a716-446655440000' \
  -H "Authorization: Bearer $EDGAZE_API_KEY"

Audience

Developers preparing a workflow run.

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 tells you whether the account has API listing access (apiRunnableNow), what the displayed run price is (displayedRunPriceUsd), and which credential mode and providers apply.

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. Check apiRunnableNow, credentialMode, and requiredProviders before POST /runs. Build inputs from the returned inputSchema: both exact 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

Inputs accept either the exact input name (topic) or nodeId (input_1). Unknown keys, ambiguous names, and conflicting values supplied through both aliases are rejected.

Was this useful?

Your response helps us improve the documentation.