OpenAPI

Runflow OpenAPI specs, in OpenAPI 3.1, with codegen recipes.

Runflow publishes a public OpenAPI 3.1 spec for customer integrations and codegen:

https://docs.runflow.io/api/openapi.public.json

The public spec is what generates the API reference tab on this site. Use it for codegen and agent integrations.

Every endpoint still requires the right Bearer token and role. A path being listed does not mean an unauthenticated caller can use it.

Codegen recipes

TypeScript types

npx openapi-typescript https://docs.runflow.io/api/openapi.public.json -o runflow-types.ts

Python client

pip install openapi-python-client
openapi-python-client generate --url https://docs.runflow.io/api/openapi.public.json

Go client

go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest
oapi-codegen -package runflow https://docs.runflow.io/api/openapi.public.json > runflow.go

Postman / Insomnia

Both import OpenAPI directly. Point them at https://docs.runflow.io/api/openapi.public.json for customer integrations.

Auth

One scheme: HTTPBearer. See Authentication.

Versioning

The path prefix is /v1. Breaking changes trigger a /v2 path. Additive changes ship in /v1.

Related

Clients

No SDKs yet, codegen instead.

API catalog

RFC 9727 linkset.