> ## 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. # Create a developer key ## OpenAPI ````yaml post /v2/admin/developer-keys openapi: 3.0.3 info: title: DeepL API Documentation description: >- The DeepL API provides programmatic access to DeepL’s language AI technology. Note: this OpenAPI spec is embedded into our API documentation and has shortened descriptions. termsOfService: https://www.deepl.com/pro-license contact: name: DeepL - Contact us url: https://www.deepl.com/contact-us version: 3.9.0 servers: - url: https://api.deepl.com description: DeepL API Pro - url: https://api-free.deepl.com description: DeepL API Free security: [] tags: - name: beta description: >- Experimental features that are under testing and not yet intended for production use. - name: TranslateText description: >- The text-translation API currently consists of a single endpoint, `translate`, which is described below. - name: TranslateDocuments description: >- The document translation API allows you to translate whole documents and supports the following file types and extensions: * `docx` - Microsoft Word Document * `pptx` - Microsoft PowerPoint Document * `xlsx` - Microsoft Excel Document * `pdf` - Portable Document Format * `htm / html` - HTML Document * `txt` - Plain Text Document * `xlf / xliff` - XLIFF Document, version 2.1 * `srt` - SRT Document * `jpeg` / `jpg` / `png` - Image (currently in beta) - name: RephraseText description: >- The `rephrase` endpoint is used to make corrections and adjustments to texts based on style or tone. - name: ManageMultilingualGlossaries description: >- The *glossary* functions allow you to create, inspect, edit and delete glossaries. Glossaries created with the glossary function can be used in translate requests by specifying the `glossary_id` parameter. A glossary contains (several) dictionaries. A dictionary is a mapping of source phrases to target phrases for a single language pair. If you encounter issues, please let us know at support@DeepL.com. Currently you can create glossaries with any of the languages DeepL supports (with the exception of Thai). The maximum size limit for a glossary is 10 MiB = 10485760 bytes and each source/target text, as well as the name of the glossary, is limited to 1024 UTF-8 bytes. A total of 1000 glossaries are allowed per account. When creating a dictionary with target language `EN`, `PT`, or `ZH`, it's not necessary to specify a variant (e.g. `EN-US`, `EN-GB`, `PT-PT`, `PT-BR`, or `ZH-HANS`). Dictionaries with target language `EN` can be used in translations with either English variant. Similarly `PT`, and `ZH` dictionaries can be used in translations with their corresponding variants. (When you provide the ID of a glossary to a translation, the appropriate dictionary is automatically applied. Currently glossaries can not yet be used with source language detection.) Glossaries created via the DeepL API are now unified with glossaries created via the DeepL website and DeepL apps. Please only use the v3 glossary API in conjunction with multilingual or edited glossaries from the website. - name: ManageGlossaries description: >- Please note that this is the spec for the (old) v2 glossary endpoint. We recommend users switch to the newer v3 glossary endpoints, which support editability and multilinguality. The *glossary* functions allow you to create, inspect, and delete glossaries. Glossaries created with the glossary function can be used in translate requests by specifying the `glossary_id` parameter. If you encounter issues, please let us know at support@DeepL.com. Currently you can create glossaries with any of the languages DeepL supports (with the exception of Thai). - name: MetaInformation description: Information about API usage and value ranges - name: TranslationMemories description: >- The translation memory endpoints allow you to interact with your account's translation memories, used to store and reuse previously created translations. Translation memories can be used in text translation requests by specifying the `translation_memory_id` parameter to denote a specific translation memory and the `translation_memory_threshold` which defines the minimum matching percentage required for a translation memory segment to be applied (recommended to be 75% or higher). - name: VoiceAPI description: >- The Voice API provides real-time voice transcription and translation services. Use a two-step flow: first request a streaming URL via REST, then establish a WebSocket connection for streaming audio and receiving transcriptions. - name: VoiceTranslateJob description: >- **Alpha.** Async voice translation jobs. This API may change without notice. externalDocs: description: DeepL Pro - Plans and pricing url: https://www.deepl.com/pro#developer paths: /v2/admin/developer-keys: post: tags: - AdminApi summary: Create a developer key as an admin operationId: adminCreateDeveloperKey requestBody: required: true content: application/json: schema: type: object properties: label: $ref: '#/components/schemas/ApiKeyLabel' responses: '200': description: >- The create function returns a JSON representation of the created API key. headers: X-Trace-ID: $ref: '#/components/headers/X-Trace-ID' content: application/json: schema: $ref: '#/components/schemas/ApiKey' '400': $ref: '#/components/responses/BadRequest' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalServerError' security: - auth_header: [] components: schemas: ApiKeyLabel: description: API key label. The default value is `DeepL API Key`. type: string example: developer key prod ApiKey: description: The API key. type: object properties: key_id: $ref: '#/components/schemas/ApiKeyId' label: $ref: '#/components/schemas/ApiKeyLabel' creation_time: description: Timestamp when the key was created (ISO 8601 format) type: string example: '2025-07-08T08:15:29.362Z' deactivated_time: description: >- Timestamp when the key was deactivated (ISO 8601 format). The default value is `null`. type: string example: '2025-07-09T08:15:29.362Z' is_deactivated: description: >- Flag indicating whether the API key is deactivated. The default value is `false`. type: boolean example: true usage_limits: description: Usage limits for the API key. type: object properties: characters: $ref: '#/components/schemas/ApiKeyUsageCharacters' speech_to_text_milliseconds: $ref: '#/components/schemas/ApiKeyUsageSpeechToTextMilliseconds' ApiKeyId: description: API key ID. Consists of two valid GUIDs separated by a colon. type: string example: >- ca7d5694-96eb-4263-a9a4-7f7e4211529e:20c2abcf-4c3c-4cd6-8ae8-8bd2a7d4da38 ApiKeyUsageCharacters: description: > Restricts the number of total characters (across text translation, document translation, and text improvement) that can be consumed by an API key in a one-month usage period. Setting the limit to `0` means the API key will not be able to consume characters. Setting the limit to `null` disables the limit, effectively allowing unlimited usage. type: number example: 5000 ApiKeyUsageSpeechToTextMilliseconds: description: > Restricts the number of milliseconds of speech-to-text that can be consumed by an API key in a one-month usage period. Setting the limit to `0` means the API key will not be able to consume speech-to-text milliseconds. Setting the limit to `null` disables the limit, effectively allowing unlimited usage. type: number example: 3600000 headers: X-Trace-ID: description: >- A unique identifier for the request that can be included in bug reports to DeepL support. schema: type: string example: 501c3d93cc0c4f11ae2f60a226c2f0f0 responses: BadRequest: description: Bad request. Please check error message and your parameters. Forbidden: description: >- Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header. NotFound: description: The requested resource could not be found. InternalServerError: description: Internal error. securitySchemes: auth_header: type: apiKey description: > Authentication with `Authorization` header and `DeepL-Auth-Key` authentication scheme. Example: `DeepL-Auth-Key ` name: Authorization in: header x-default: 'DeepL-Auth-Key ' ````