{"openapi":"3.1.0","info":{"title":"DeepL (BYOK) API","version":"0.1.0","description":"DeepL (BYOK) lets an AI assistant read your own DeepL data through the DeepL API with a key you supply (DeepL API authentication key). Read-only: 10 tools (get_usage, list_languages, list_glossary_language_pairs, list_glossaries, get_glossary, get_glossary_entries, list_translation_memories, get_translation_memory, list_translation_memory_segments, list_style_rules). The BYOK key travels with...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-deepl.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-deepl/docs"},"termsOfService":"https://connectorbay.com/byok-deepl/terms"},"servers":[{"url":"https://byok-deepl.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-deepl/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_usage":{"post":{"operationId":"get_usage","summary":"Show characters (and speech minutes) used in the current billing period next to the account limits, plus document counts","description":"Show characters (and speech minutes) used in the current billing period next to the account limits, plus document counts. Use for \"How many DeepL characters have I used this month\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"}},"required":["plan"],"title":"get_usageArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_languages":{"post":{"operationId":"list_languages","summary":"List the languages DeepL supports as source or as target, with codes and names (target languages also say whether formal","description":"List the languages DeepL supports as source or as target, with codes and names (target languages also say whether formality is supported). Use for \"Which target languages does DeepL support\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"type":{"anyOf":[{"enum":["source","target"],"type":"string"},{"type":"null"}],"default":"source","description":"Which list: source or target.","title":"Type"}},"required":["plan"],"title":"list_languagesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_glossary_language_pairs":{"post":{"operationId":"list_glossary_language_pairs","summary":"List the source and target language pairs for which glossaries can be created. Use for \"Which language pairs can I use i","description":"List the source and target language pairs for which glossaries can be created. Use for \"Which language pairs can I use in a DeepL glossary\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"}},"required":["plan"],"title":"list_glossary_language_pairsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_glossaries":{"post":{"operationId":"list_glossaries","summary":"List all glossaries of the account with their language dictionaries and entry counts (without the entries themselves). U","description":"List all glossaries of the account with their language dictionaries and entry counts (without the entries themselves). Use for \"Which glossaries do I have in DeepL\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"}},"required":["plan"],"title":"list_glossariesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_glossary":{"post":{"operationId":"get_glossary","summary":"Get one glossary's name, creation time and language dictionaries with entry counts. Use for \"Show details of DeepL gloss","description":"Get one glossary's name, creation time and language dictionaries with entry counts. Use for \"Show details of DeepL glossary def3a26b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"glossary_id":{"description":"Glossary id as returned by list_glossaries.","maxLength":200,"title":"Glossary Id","type":"string"}},"required":["plan","glossary_id"],"title":"get_glossaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_glossary_entries":{"post":{"operationId":"get_glossary_entries","summary":"Get the entries of one glossary for one language pair as tab-separated text (source term, tab, target term per line). Us","description":"Get the entries of one glossary for one language pair as tab-separated text (source term, tab, target term per line). Use for \"List the English to German entries of DeepL glossary def3a26b\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"glossary_id":{"description":"Glossary id as returned by list_glossaries.","maxLength":200,"title":"Glossary Id","type":"string"},"source_lang":{"description":"Source language code of the dictionary, for example 'en'.","maxLength":10,"title":"Source Lang","type":"string"},"target_lang":{"description":"Target language code of the dictionary, for example 'de'.","maxLength":10,"title":"Target Lang","type":"string"}},"required":["plan","glossary_id","source_lang","target_lang"],"title":"get_glossary_entriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_translation_memories":{"post":{"operationId":"list_translation_memories","summary":"List translation memories with source and target languages, segment counts and update time. Use for \"Which translation m","description":"List translation memories with source and target languages, segment counts and update time. Use for \"Which translation memories does my DeepL account have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first page to return, starting at 0.","title":"Page"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results per page (1 to 100).","title":"Page Size"}},"required":["plan"],"title":"list_translation_memoriesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_translation_memory":{"post":{"operationId":"get_translation_memory","summary":"Get one translation memory's languages, segment count and timestamps. Use for \"Show DeepL translation memory a7d3c6f1\".","description":"Get one translation memory's languages, segment count and timestamps. Use for \"Show DeepL translation memory a7d3c6f1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"translation_memory_id":{"description":"Translation memory id as returned by list_translation_memories.","maxLength":200,"title":"Translation Memory Id","type":"string"}},"required":["plan","translation_memory_id"],"title":"get_translation_memoryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_translation_memory_segments":{"post":{"operationId":"list_translation_memory_segments","summary":"List stored segments of a translation memory with source text and target translations, optionally filtered by text. Use ","description":"List stored segments of a translation memory with source text and target translations, optionally filtered by text. Use for \"Find segments containing 'invoice' in DeepL translation memory a7d3c6f1\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"translation_memory_id":{"description":"Translation memory id as returned by list_translation_memories.","maxLength":200,"title":"Translation Memory Id","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"How many segments per page (1 to 100).","title":"Page Size"},"page_cursor":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"The next_page_cursor of a previous answer; omit for the first page.","title":"Page Cursor"},"filter_text":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only segments where this text appears in the source or any target.","title":"Filter Text"}},"required":["plan","translation_memory_id"],"title":"list_translation_memory_segmentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_style_rules":{"post":{"operationId":"list_style_rules","summary":"List style rule lists (writing conventions applied to translations) with language and version. Use for \"Which style rule","description":"List style rule lists (writing conventions applied to translations) with language and version. Use for \"Which style rule lists are set up in my DeepL account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"plan":{"description":"Which DeepL API plan the key belongs to: 'api-free' for keys ending in ':fx' (Free plan) or 'api' for DeepL API Pro keys.","enum":["api","api-free"],"title":"Plan","type":"string"},"page":{"anyOf":[{"maximum":100000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Index of the first page to return, starting at 0.","title":"Page"},"page_size":{"anyOf":[{"maximum":25,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many lists per page (1 to 25).","title":"Page Size"}},"required":["plan"],"title":"list_style_rulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}