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

# Overview

> The SuperAI Flows REST API — base URL, conventions, and how the reference is organized.

The SuperAI Flows API is a unified REST API for defining, executing, and monitoring workflows. It combines the core workflow API and the AI agent API into a single coherent surface served from one domain.

## Base URL

```
https://flows.super.ai
```

| Surface   | Path prefix    | Purpose                                             |
| --------- | -------------- | --------------------------------------------------- |
| Main API  | `/api/*`       | Flows, executions, tasks, integrations, files, auth |
| Agent API | `/api/agent/*` | AI agent and conversation endpoints                 |

## Conventions

The API follows Stripe-inspired design principles:

* **RESTful endpoints** with intuitive, resource-oriented paths
* **Standard HTTP methods** — `GET`, `POST`, `PATCH`, `DELETE`
* **Standard HTTP status codes** for success and error handling
* **Consistent JSON** request and response bodies
* **`request_id` on every response** for log correlation and support

## Authentication

Most endpoints require a JWT bearer token; some accept a service-account API key. See [Authentication](/api-reference/authentication) for the full flow.

```bash theme={null}
curl https://flows.super.ai/api/flows \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

## Resource groups

The endpoint reference in this section is generated directly from the OpenAPI specification and grouped by resource:

<CardGroup cols={2}>
  <Card title="Flows" icon="diagram-project">
    Create, list, and manage workflow definitions.
  </Card>

  <Card title="Flow Executions" icon="play">
    Run flows and monitor execution status.
  </Card>

  <Card title="Task Executions & Outputs" icon="list-check">
    Inspect individual task runs and their results.
  </Card>

  <Card title="Integrations & Plugins" icon="plug">
    Connect flows to external services and platforms.
  </Card>

  <Card title="Files" icon="file">
    Download files referenced in task outputs.
  </Card>

  <Card title="Service Accounts" icon="key">
    Manage programmatic API access credentials.
  </Card>
</CardGroup>

## Versioning & compatibility

The API follows a strict compatibility policy. Non-breaking changes (new endpoints, optional parameters, new response fields, new enum values) ship without notice — design your clients to ignore unknown fields. Breaking changes are announced at least **15 days in advance** with migration guides.

## Errors

All errors share a consistent JSON shape with a machine-readable `code` and a `request_id`. See the [Error Codes reference](/api-reference/errors).

```json theme={null}
{
  "error": {
    "message": "Human-readable error description",
    "code": "machine_readable_error_code"
  },
  "request_id": "01K8KACP7D2XFGHJ9KLM4NPQR8"
}
```