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

# API reference

> The SortX HTTP API: base URL, authentication, errors and limits.

The SortX API is the same API the staff app uses. Every endpoint page in this section is
generated from the API's OpenAPI document, so it matches what the API actually accepts and
returns.

## Base URL

```
https://api.sortx.co.uk
```

## Authentication

Send a workspace API key in the `x-api-key` header. Each endpoint needs the key to hold its
group's `read` or `write` scope. See [Authentication and API keys](/developers/api-keys).

## Errors

Errors are JSON with a status code that means what it says:

| Status | Meaning |
| - | - |
| `400` | The request did not match the endpoint's schema. |
| `401` | No key, or the key is invalid, expired or revoked. |
| `403` | The key lacks the scope, the workspace lacks the product, or only an owner may do this. |
| `404` | Not found in this workspace. |
| `409` | The request conflicts with the record's current state (for example, a job already closed). |
| `429` | Fair-use budget spent; retry after `Retry-After` seconds. |
| `503` | A dependency is unavailable; retry later. |

Each endpoint page lists the errors that endpoint can return, with their bodies.


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