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

Edgaze REST API

Run marketplace workflows from your backend. Same billing and execution as the product UI. Ship your first API call in minutes.

Base URL

Pin this origin in your SDK or HTTP client. All paths below are relative to it.

https://api.edgaze.ai/v1

How it works

Three primitives. Most integrations only need these.

API keys

Scoped secrets with optional spend caps. One header on every request.

Read more
Runs

Async execution. POST to start, GET to poll, events for step progress.

Read more
Webhooks

Signed callbacks on completion. Skip the poll loop in production.

Read more

Integration flow

From API key to completed run: the path most teams ship.

  1. 01
    Authenticate

    Authorization: Bearer …

  2. 02
    Discover

    GET /workflows

  3. 03
    Execute

    POST /runs → 202

  4. 04
    Track

    Poll or webhook

  5. 05
    Consume

    Read outputs

Quickstart guide

Reference

Guides for auth, billing, and webhooks. Endpoint pages include a playground and copy-paste snippets.

Getting started

  • Authentication

    Authenticate every request with a secret API key. Keys are scoped, rate-limited, and optionally spend-capped.

  • Quickstart

    Create a key, discover a workflow, start a run, and poll for completion in under five minutes.

Workflows

  • GET
    List Workflows

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

  • GET
    Get Workflow

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

  • GET
    List Workflow Versions

    List immutable workflow versions visible to the caller and inspect active and purchase pins.

  • POST
    Accept Workflow Update

    Re-pin a buyer's purchase to the workflow's current active immutable version.

Runs

  • POST
    Create Run

    Start an asynchronous workflow run. Returns 202 Accepted with URLs to poll status and read events.

  • GET
    List Runs

    Page through your account's run history, newest first.

  • GET
    Get Run

    Poll canonical run status, failure reason, buyer-facing charge, and final outputs.

  • POST
    Cancel Run

    Stop a run that is still in flight. Cancelled runs are never charged.

  • GET
    List Run Events

    Read the durable event log for a run: started, node progress, and completion markers.

Guides

  • Webhooks

    Receive signed HTTP callbacks when runs reach terminal states. Manage endpoints from the Developer console.

  • Errors & Edge Cases

    Complete reference for error codes, HTTP status mapping, async failure modes, and security behavior.

  • Billing & Spend Caps

    How API runs are funded, capped, and charged relative to the product UI.

  • Streaming & Real-time

    Poll runs, read events, and stream live output during execution.

  • OpenAPI specification

    Machine-readable OpenAPI 3.1 document, generated from the same Zod schemas the handlers use.

Platform status

Live operational summary for API, runtime, and marketplace surfaces. Opens the public status page for incident history and component detail.

Checking platform status
status.edgaze.ai

Developer console

Create keys, set spend caps, configure webhooks, and debug delivery.

Open console

Was this useful?

Your response helps us improve the documentation.

Authentication →
On this page
Get startedBase URLHow it worksIntegration flowReferenceDeveloper console
© 2026 Edge Platforms, Inc. All rights reserved.