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

# OpenAPI spec

> Download the OpenAPI specification for the DeepL API

This repository contains an [OpenAPI specification](https://openapis.org/) of the DeepL API in YAML and JSON formats.

| File                                                                                                                      | Format | Description                               |
| ------------------------------------------------------------------------------------------------------------------------- | ------ | ----------------------------------------- |
| [`openapi.yaml`](https://raw.githubusercontent.com/DeepLcom/api-docs/main/api-reference/openapi.yaml)                     | YAML   | Main REST API spec (source of truth)      |
| [`openapi.json`](https://raw.githubusercontent.com/DeepLcom/api-docs/main/api-reference/openapi.json)                     | JSON   | Same content, auto-generated from YAML    |
| [`voice.asyncapi.yaml`](https://raw.githubusercontent.com/DeepLcom/api-docs/main/api-reference/voice/voice.asyncapi.yaml) | YAML   | AsyncAPI spec for the streaming Voice API |
| [`voice.asyncapi.json`](https://raw.githubusercontent.com/DeepLcom/api-docs/main/api-reference/voice/voice.asyncapi.json) | JSON   | Same content, auto-generated from YAML    |

You can use these specs to explore the API in tools like [Postman](https://www.postman.com/), or to auto-generate SDKs and code libraries using tools such as [Swagger Editor](https://editor.swagger.io/?url=https://raw.githubusercontent.com/DeepLcom/api-docs/main/api-reference/openapi.yaml) or [OpenAPI Generator](https://openapi-generator.tech/).

<Note>
  Swagger's "Try it out" in-browser simulator creates valid curl requests, but requests will fail due to [CORS restrictions](/docs/best-practices/cors-requests).
</Note>

The spec files live in the [`api-reference/`](https://github.com/DeepLcom/api-docs/tree/main/api-reference) directory of the [api-docs repository](https://github.com/DeepLcom/api-docs). If you encounter issues or have feature requests, [create an issue](https://github.com/DeepLcom/api-docs/issues).
