Workflows

Get workflow

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

get/workflows/{id}

Request

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

Path parameters

idstring required

UUID of the workflow.

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

Response

Workflow detail.

idstring uuid required
namestring required
descriptionstring nullable required
ownerHandlestring nullable required
edgazeCodestring nullable required
runModel'free' | 'per_run' required

Pricing model for a workflow listing.

displayedRunPriceUsdnumber nullable required

Estimated run price shown to the buyer. The final price is confirmed when the run starts and may differ slightly from older catalog data. 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.

pricingExplanationstring nullable required

Human-readable note on how this listing is priced. Present whenever displayedRunPriceUsd is a positive estimate; explains that settlement uses the live quote at run start.

userAccess'owned' | 'purchased' | 'wallet' | 'purchase_required' required

How the authenticated key holder can currently pay to run this workflow: owned (the caller is the creator), purchased (a prior purchase covers it), or wallet (it will be billed to wallet balance at run time). purchase_required marks legacy unlock listings that cannot be run or bought through the API — apiRunnableNow is false and POST /runs returns 403 forbidden. Purchasing is a web-only checkout flow; send the buyer to purchaseUrl on the workflow detail response.

accessLabelstring required
apiRunnableNowboolean required
apiAccessAllowedboolean required
purchaseUrlstring uri nullable required

Web checkout page for this workflow, or null when it has no public listing. Purchasing is not available through the API; send a buyer here when userAccess is purchase_required.

credentialMode'edgaze_hosted' | 'byok' required

Whether the workflow runs on Edgaze-hosted credentials or the caller's own keys.

requiredProvidersRequiredProvider[] required
versionIdstring uuid nullable required
versionLabelstring nullable required
pinnedVersionIdstring uuid nullable required

Version the caller is pinned to via a prior purchase, or null when they follow the active version.

activeVersionIdstring uuid nullable required

Current active version published by the workflow owner.

updateAvailableboolean required

True when the caller is pinned to an older version than the active one. Same workflow id can execute different immutable graphs.

inputCountinteger required

Changes

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