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

# API overview

> Base URL, endpoint map, request conventions, and response conventions for the Aspas Labs API.

The endpoint pages in this section are generated from the versioned OpenAPI document in `openapi.json`. The generated pages include request parameters, schemas, responses, and API examples.

## Base URL

```text theme={null}
https://api.aspaslabs.com
```

Versioned product endpoints use `/v1`. Health endpoints use `/health`.

## Endpoint map

### Decisions

| Method | Path | Authentication | Description |
| - | - | - | - |
| `POST` | `/v1/decisions` | No key required (free) | Run one structured decision. |

### Models

| Method | Path | Authentication | Description |
| - | - | - | - |
| `GET` | `/v1/models` | No key required (free) | List available models and limits. |
| `GET` | `/v1/models/{model}` | No key required (free) | Read one model descriptor. |

### Catalogs

| Method | Path | Authentication | Description |
| - | - | - | - |
| `POST` | `/v1/catalogs` | Bearer key required | Create a reusable catalog. |
| `GET` | `/v1/catalogs/{id}` | Bearer key required | Read a catalog you own. |
| `DELETE` | `/v1/catalogs/{id}` | Bearer key required | Delete a catalog you own. |

### Health

| Method | Path | Description |
| - | - | - |
| `GET` | `/health/live` | Check whether the process is alive. |
| `GET` | `/health/ready` | Check whether the API and an inference worker are ready. |

## HTTP conventions

* Requests with JSON bodies use `Content-Type: application/json`.
* Successful responses are JSON except `204 No Content` for a successful catalog delete.
* Error responses use an `{ "error": { ... } }` envelope.
* Responses may include `X-Request-ID` for support and tracing.
* Rate-limited responses may include `Retry-After` and rate-limit headers.

## Generated API pages

Select an operation in the sidebar to view its full contract. The API reference is the source of truth for exact field names, required properties, response codes, and model schemas.

If the narrative guide and the generated schema ever disagree, treat the OpenAPI contract as authoritative and open an issue with the request ID or affected operation.

<Info>
  The free decision and model endpoints require no API key. Catalog operations are protected and require a bearer key. This API reference describes HTTP access to Aspas Labs; it does not describe a dashboard or hosted UI because those surfaces do not exist yet.
</Info>


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