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

# API Reference Overview

> Programmatically trigger flow executions, manage suites, and query platform analytics.

The Quixa REST API allows developers, DevOps pipelines, and automation bots to interact with all platform resources programmatically.

***

## 1. Authentication

All requests to the Quixa API require authentication via **Bearer Token** or **API Key**:

```bash theme={null}
# Using an API Key header
curl -X GET "https://api.quixa.io/api/gateway/flows" \
  -H "X-Api-Key: qxa_live_YOUR_API_KEY"

# Or using standard Bearer Token
curl -X GET "https://api.quixa.io/api/gateway/flows" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
```

<Note>
  API Keys can be generated with scoped privileges (`FullControl`, `ExecuteOnly`, `ReadOnly`) inside the **Backoffice** -> **Access Control & ReBAC** panel.
</Note>

***

## 2. Core Endpoint Summary

| Category | Method & Endpoint | Description |
| :- | :- | :- |
| **Flows** | `GET /api/gateway/flows` | List all flows in tenant workspace. |
| **Flows** | `GET /api/gateway/flows/{id}` | Retrieve flow DAG structure and node configurations. |
| **Execution** | `POST /api/gateway/flows/{id}/run` | Trigger immediate visual workflow execution. |
| **Execution** | `GET /api/gateway/executions/{id}` | Retrieve execution trace history, status, and latencies. |
| **Suites** | `GET /api/gateway/suites` | List all registered Flow & Test Suites. |
| **Suites** | `POST /api/gateway/suites/{id}/run` | Trigger CI/CD suite execution pipeline. |
| **Schedules** | `GET /api/schedules` | List active Hangfire cron execution schedules. |

***

## 3. Standard Response Format

All successful responses return structured JSON:

```json theme={null}
{
  "success": true,
  "data": {
    "executionId": "f7a1c8b2-5e4d-4911-82ab-0e927c3d10fa",
    "status": "Completed",
    "durationMs": 412,
    "nodesExecuted": 8,
    "nodesSkipped": 2
  }
}
```

In the event of an error:

```json theme={null}
{
  "success": false,
  "error": {
    "code": "FLOW_NOT_FOUND",
    "message": "Workflow with ID '...' could not be resolved in the active tenant."
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.