5-minute Quickstart
Make your first API call against the Score Image endpoint.
Authentication
How the
x-api-key header works and how to get a key.Who this is for
- External developers shipping AI photo features without standing up models
- Partner & agency engineers integrating Runflow into customer products
- Technical power users who want a single endpoint per use case
Mental model
Runflow wraps production-ready AI pipelines behind HTTP endpoints. You send an image (or a set of images) plus a few parameters, Runflow runs the pipeline, and you get back either an immediate JSON result (synchronous) or a webhook callback when the job is ready (asynchronous).- Synchronous endpoints return in the same HTTP call. Good for anything that finishes in under a few seconds — scoring, classification, lightweight edits.
- Asynchronous endpoints return a job ID immediately and POST the final result to your webhook when ready. Use these for anything that takes minutes or hours — headshot generation, batch processing, long-running pipelines.
Currently available endpoints
| Endpoint | Method | Type | Description |
|---|---|---|---|
/api/v1/images/score | POST | Sync | Analyze a portrait photo and return a quality score (0.0–1.0), brightness, sharpness, and improvement tips. |
/api/v1/images/generate-headshots | POST | Async + webhook | Submit portrait photos and receive 60 professional AI headshots via webhook callback (~1–2 hours). |
Need an API key? Talk to the founders — we’ll set you up with credentials and help you integrate.
Conventions
- Base URL:
https://api.runflow.io - Auth header:
x-api-key: YOUR_API_KEYon every request - Request formats: every endpoint accepts either
multipart/form-data(file upload) orapplication/json(public image URLs) - Response format: JSON on every successful response
Where to go next
Quickstart
Make your first API call in 5 minutes.
Authentication
API key setup and best practices.
Webhooks
Handle async callbacks — 24h expiry, handler example.
Flows & Pipelines
How Runflow’s building blocks fit together.