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
Workflows

List Workflows

Discover current free and pay-per-run workflows in the paginated marketplace catalog.

curl --fail-with-body --silent --show-error 'https://api.edgaze.ai/v1/workflows?offset=0&limit=24&sort=popular' \
  -H "Authorization: Bearer $EDGAZE_API_KEY"
Audience

Developers discovering runnable workflows.

GEThttps://api.edgaze.ai/v1/workflows

Overview#

Use this endpoint to discover workflow catalog metadata before starting a run. It is the first call in most integrations: list or search workflows, select one with apiRunnableNow: true, fetch its detail for inputSchema, then POST /runs with the workflow id and inputs.

With no query parameters you get the paginated Marketplace catalog. This is the recommended discovery path. Use scope=mine only when you specifically need workflows published by the authenticated account.

The list response does not contain inputSchema. Use q, offset, and limit to search, then fetch GET /workflows/{id} before creating a run.

Authorization#

Required scopes (either satisfies this endpoint):

run:readrun:execute

Pass the key as a Bearer token: Authorization: Bearer edgaze_sk_live_…

Parameters#

Headers

Authorizationstringheaderrequired

Bearer token with your secret API key.

Example: Bearer edgaze_sk_live_…

Query parameters

scopestringquery

Marketplace catalog or the key holder's current workflows. Defaults to marketplace.

Allowed: mine · marketplace

qstringquery

Search title, description, tags, owner handle, or Edgaze Code.

offsetintegerquery

Pagination offset. Used with marketplace scope.

limitintegerquery

Page size (max 50).

sortstringquery

Marketplace sort order.

Allowed: popular · newest

runModelstringquery

Filter by pricing model.

Allowed: free · per_run

runnableOnlybooleanquery

When true, only workflows the key holder can run right now.

Response#

All responses are JSON. Errors use { error: { code, message } }. Example success and error payloads are in the request/response panel above.

Edge cases#

Default scope

A bare request is the marketplace catalog; scope=mine returns current owned workflows.

Scope requirement

Either run:read or run:execute satisfies the scope check for this endpoint.

Was this useful?

Your response helps us improve the documentation.

← QuickstartGet Workflow →
On this page
OverviewAuthorizationParametersResponseEdge cases
© 2026 Edge Platforms, Inc. All rights reserved.