# API Documentation

Source: https://docs.ops0.com/docs/api-docs

An interactive, always-current reference for the ops0 REST API, available in-app at **API Docs**.

![ops0 API Documentation page showing the interactive Swagger UI with route list](https://docs.ops0.com/images/api-docs.png)

**Auto-Generated**

This isn't a hand-maintained reference — it's rendered directly from the live RBAC registry. Every route shown reflects what's actually deployed, including the exact fine-grained authorization (FGA) permission it requires.

## What You Get

Interactive Swagger UI

Browse, expand, and try requests against every documented route

Live Spec

Generated from the running API, not a static file that can drift

Permission Per Route

Each route lists the RBAC/FGA permission required to call it

Route Count

Total documented endpoints shown at the top of the page

## Accessing API Docs

Navigate to **API Docs** in the app. The page loads the OpenAPI spec from your organization's live API and renders it with Swagger UI — you must be signed in, since the spec is fetched with your session's authorization.

## Using It to Build Integrations

The API Docs page is the fastest way to find:

- The exact request/response shape for any resource (projects, deployments, discovery sessions, workflows, servers, and more)
- Which permission your API token or service account needs before calling a given route — useful when setting up [API Keys](https://docs.ops0.com/docs/settings/api-keys) with least-privilege scopes
- Whether a route exists at all before you start building against it

## Related

- [API Keys](https://docs.ops0.com/docs/settings/api-keys): Create and scope API keys for programmatic access.

- [API & Deployment Configuration](https://docs.ops0.com/docs/settings/api-configuration): Configure AI provider keys and deployment settings.

- [IAM & Roles](https://docs.ops0.com/docs/settings/iam): Understand the permission model that governs every API route.