> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runflow.io/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](/api-reference/models/search-models) tab on this site. Use it for codegen and agent integrations.

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

## Codegen recipes

### TypeScript types

```bash theme={"dark"}
npx openapi-typescript https://docs.runflow.io/api/openapi.public.json -o runflow-types.ts
```

### Python client

```bash theme={"dark"}
pip install openapi-python-client
openapi-python-client generate --url https://docs.runflow.io/api/openapi.public.json
```

### Go client

```bash theme={"dark"}
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](/concepts/authentication).

## Versioning

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

## Related

<CardGroup cols={2}>
  <Card title="Clients" icon="laptop-code" href="/concepts/clients">No SDKs yet, codegen instead.</Card>
  <Card title="API catalog" icon="link" href="/agents/api-catalog">RFC 9727 linkset.</Card>
</CardGroup>