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

# Setup & Configuration

> Complete setup guide for the Swarms API. Learn how to configure authentication, set up your development environment, and start building with our multi-agent swarm platform.

| **Argument** | **Description** | **Value** | **Notes** |
| - | - | - | - |
| **Base URL / Domain** | The base URL or domain for the Swarms API | `https://api.swarms.world` | Production URL for all API requests |
| **Headers: x-api-key** | API key header for authentication | `x-api-key: <your-api-key>` | Required for authenticating requests |
| **Headers: Authorization** | Alternative authentication header | `Authorization: Bearer <your-api-key>` | Accepted as an alternative to `x-api-key` (OpenAI SDK compatibility) |
| **Headers: Content-Type** | Specifies the media type of the request body | `application/json` | Indicates JSON payload for POST/PUT requests |
| **Headers: Accept-Encoding** | Compression formats supported by the client | `gzip, lz4` | Client indicates it can handle gzip or lz4 compressed responses |
| **Method** | HTTP methods supported | `GET`, `POST` | Every current endpoint is either `GET` (read-only) or `POST` (completions/workflows) |
| **Request Body** | JSON payload for requests (for POST) | `{"key": "value"}` | Must conform to `application/json` content type |
| **Response Format** | Expected response format | `application/json` | API returns JSON responses |
| **Compression** | Compression algorithms supported for response | `gzip`, `lz4` | Server may compress responses if client supports it (via Accept-Encoding) |

### Notes:

* **Base URL**: Use `https://api.swarms.world` for all API requests.
* **API Key**: Replace `<your-api-key>` with the actual key provided by the Swarms API service.
* **Authentication**: Pass your key in the `x-api-key` header, or use `Authorization: Bearer <your-api-key>` — both are accepted.
* **Compression**: `gzip` and `lz4` are supported for response compression via the `Accept-Encoding` header.


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