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

# Swagger UI

> Explore the Tirdad API interactively: the built-in playground on this site, or a local Swagger UI against the spec

You do not need to run anything to try the API. Every endpoint page in the [API Reference](https://docs.tirdad.ai/api-reference/introduction.md) has a playground: choose the region, paste an API key, edit the body, and send. This page covers running Swagger UI yourself for cases the playground does not reach, such as an Enterprise deployment on a private network or a spec build from a branch.

## Run Swagger UI locally

Swagger UI is a static site that renders any OpenAPI document. Run it in Docker against the published spec:

```sh theme={null}
curl -sSL https://docs.tirdad.ai/api-reference/openapi.json -o tirdad-openapi.json

docker run --rm -p 8081:8080 \
  -e SWAGGER_JSON=/spec/tirdad-openapi.json \
  -v "$PWD:/spec" \
  swaggerapi/swagger-ui
```

Open `http://localhost:8081`, click **Authorize**, and enter your API key for `ApiKeyAuth`. The **Servers** dropdown lists the Tirdad API from the spec.

> [!WARNING]
>
> Requests from a local Swagger UI go straight to the Tirdad API with your key. Use a sandbox key while exploring.

## Swagger UI, Postman, or the API reference?

| Tool | Best for |
| - | - |
| API Reference playground | Trying Tirdad Cloud endpoints with no setup |
| Swagger UI | Branch builds of the spec, air-gapped networks |
| [Postman](https://docs.tirdad.ai/developers/api-tooling/postman.md) | Saved requests, environments per region, sharing with a team |

> [card] [OpenAPI spec](https://docs.tirdad.ai/developers/api-tooling/openapi-spec.md)


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