Skip to content

docs: add style_profile_id to POST /v2/translate #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lawl-dev wants to merge 7 commits into from
Closed

docs: add style_profile_id to POST /v2/translate #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
30689ad
feat: document style profile endpoints
Sep 1, 2026
da587d8
feat: document the spoken terms link on style profiles
Sep 1, 2026
c20ac4a
feat: note that a style profile holds one style rule list per target …
Sep 3, 2026
3e8b2a1
feat: drop adaptive_translation_enabled from the style profile endpoints
Sep 4, 2026
7d9ec59
feat: rename two style profile fields after review
Sep 7, 2026
243aaae
fix: add the missing spoken_terms_ids to the list response example
Sep 8, 2026
1d9d9ef
docs: add style_profile_id to POST /v2/translate
Sep 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,130 changes: 1,014 additions & 116 deletions api-reference/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

793 changes: 792 additions & 1 deletion api-reference/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions api-reference/style-profiles/create-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: post /v3/style_profiles
title: "Create a style profile"
description: "Learn how to create a style profile, from a name on its own to a fully configured bundle, and what happens when a component ID is rejected."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/delete-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: delete /v3/style_profiles/{style_profile_id}
title: "Delete a style profile"
description: "Learn how to delete a style profile you own, and why the components it bundled are only unlinked."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/get-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: get /v3/style_profiles/{style_profile_id}
title: "Retrieve a style profile"
description: "Learn how to fetch a single style profile's linked components, metadata, and timestamps by its ID."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/list-all-style-profiles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: get /v3/style_profiles
title: "List style profiles"
description: "Learn how to page through the style profiles your account owns and the ones shared with it, newest first."
---
5 changes: 5 additions & 0 deletions api-reference/style-profiles/update-style-profile.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
openapi: patch /v3/style_profiles/{style_profile_id}
title: "Update a style profile"
description: "Learn how to rename a style profile, clear its description or industry, and replace the set of components it links."
---
11 changes: 11 additions & 0 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,17 @@
],
"drilldown": false
},
{
"group": "Style Profiles",
"pages": [
"api-reference/style-profiles/list-all-style-profiles",
"api-reference/style-profiles/create-style-profile",
"api-reference/style-profiles/get-style-profile",
"api-reference/style-profiles/update-style-profile",
"api-reference/style-profiles/delete-style-profile"
],
"drilldown": false
},
{
"group": "Style Rules",
"pages": [
Expand Down
1 change: 1 addition & 0 deletions docs/customize/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ DeepL's customization features let you control terminology, style, and consisten
| [Custom instructions](/docs/customize/custom-instructions) | Tone, phrasing, and domain-specific behavior via natural-language directives | Inline per request via `custom_instructions`, or stored in a style rule list |
| [Translation memories](/docs/customize/using-translation-memories) | Reuse of your previously approved translations for matching segments | Stored on your account; passed per request via `translation_memory_id` |
| [Spoken terms](/docs/customize/improving-transcription-with-spoken-terms) | Recognition of specific terms during Voice API speech transcription | Stored on your account; passed per voice session via `spoken_terms_id` |
| [Style profiles](/api-reference/style-profiles/list-all-style-profiles) | A named bundle of glossaries, style rules, translation memories and example documents for one purpose | Stored on your account; passed per request via `style_profile_id`, which stands in for the individual parameters |

Glossaries, style rules, custom instructions, and translation memories work with both [text translation](/docs/translate/translate-text-quickstart) and [document translation](/docs/translate/translate-documents-quickstart), support all `model_type` values, and can be combined in a single request. Spoken terms apply to [Voice API](/docs/voice/overview) sessions, where they can be combined with glossaries.

Expand Down
Loading