Skip to main content
No versioning guarantees. The Platform API powers the Runflow app internally and is exposed for power users. Endpoints, payloads, and behavior can change without notice. Prefer the public API whenever it covers your use case.

​
What this is

The Platform API is the same HTTP surface the Runflow dashboard uses to manage runs, assets, webhooks, and callback secrets. It exposes operational primitives that don’t fit neatly into the public API — things like searching run history, inspecting per-node logs, redelivering webhook callbacks, and managing asset folders. It’s complementary to the public API, not a replacement: most integrations should live on the public API (/api/v1/images/*) and only drop down to the Platform API for the specific gaps they need.

​
When to use it

Use the Platform API when you need to:
  • Observe async work — search runs, fetch node-run logs, inspect webhook delivery history, redeliver a failed callback
  • Manage assets programmatically — upload images via presigned URLs, organize them into folders, list or delete
  • Manage webhooks & secrets — create webhook subscriptions, rotate callback signing secrets, audit delivery attempts
If you’re just running an image pipeline, stick with the public API — it’s simpler, versioned, and stable.

​
How to get access

The Platform API is gated. Access is granted case-by-case.
Talk to the founders — tell us what you’re building and we’ll issue Platform API credentials.

​
Authentication

The Platform API uses Bearer tokens, not the x-api-key header that the public API uses. Every request must include an Authorization header: 
Authorization: Bearer YOUR_PLATFORM_TOKEN
  • Base URL: https://api.runflow.io
  • Auth header: Authorization: Bearer <token>
  • Content type: application/json on all mutations
Tokens are long-lived and tied to your organization. Treat them like a password: don’t commit them, rotate on a schedule, and revoke immediately on exposure.

​
Stability contract

Public APIPlatform API
Versioned (/api/v1/...)Unversioned (/v1/...)
Breaking changes require a new versionCan change without notice
x-api-key headerAuthorization: Bearer token
Self-serve onboardingGated access
Full DX investment (SDKs, code samples)Reference-only
If you build against the Platform API, subscribe to the Runflow changelog and be prepared to update your integration when things shift.

​
Where to go next

Endpoints overview

A curated tour of Runs, Assets, and Webhooks — what’s in each category and when to use it.

Platform Spec

Jump straight into the full endpoint reference — parameters, schemas, and a live “Try it” playground.