Create a style profile

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.

POST /v3/style_profiles

cURL

MetadataOnly

curl --request POST \ --url https://api.deepl.com/v3/style_profiles \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "name": "Marketing, Japanese" } '

201

Basic

{ "style_profile_id": "3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47", "name": "Legal, German", "description": "Contract wording for the German market.", "industry": "Legal", "glossary_ids": [ "4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81" ], "style_rule_ids": [ "bd0a38f3-1831-440b-a8dd-2c702e2325ab" ], "translation_memory_ids": [ "a74d88fb-ed2a-4943-a664-a4512398b994" ], "example_document_ids": [ "9e7b41c2-58da-4a03-b6f1-3c85e0d97a26" ], "spoken_terms_id": "def3a26b-3e84-45b3-84ae-0c0aaf3525f7", "glossary_priority_enabled": true, "creation_time": "2026-04-01T16:34:25.223Z", "updated_time": "2026-04-01T16:34:25.223Z" }

Authorizations

Authorization · string · header · default: DeepL-Auth-Key · required

Authentication with Authorization header and DeepL-Auth-Key authentication scheme. Example: DeepL-Auth-Key <api-key>

Body

application/json

name · string · required

Name for the style profile. At most 255 characters. An empty name is rejected with 400 Bad Request.

Example:

"Legal, German"

description · string

Free-text description of the style profile. At most 1000 characters. Omit it to create the style profile without a description.

Example:

"Contract wording for the German market."

industry · string

The industry the style profile is written for. At most 255 characters. Omit it to create the style profile without an industry.

Example:

"Legal"

glossary_ids · string<uuid>[]

The IDs of the glossaries to link, in the order they should be applied. Defaults to an empty list.

Example:

["4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"]

style_rule_ids · string<uuid>[]

The IDs of the style rule lists to link, in the order they should be applied. At most one style rule list per target language. Defaults to an empty list.

Example:

["bd0a38f3-1831-440b-a8dd-2c702e2325ab"]

translation_memory_ids · string<uuid>[]

The IDs of the translation memories to link, in the order they should be applied. At most one translation memory per source language. Defaults to an empty list.

Example:

["a74d88fb-ed2a-4943-a664-a4512398b994"]

example_document_ids · string<uuid>[]

The IDs of the example documents to link, in the order they should be applied. A document must be fully imported before it can be linked. Defaults to an empty list.

Example:

["9e7b41c2-58da-4a03-b6f1-3c85e0d97a26"]

spoken_terms_id · string<uuid>

The ID of the Spoken Terms collection to link, applied when the style profile is used for speech rather than text. A style profile links at most one collection. Omit it to create the style profile without one. See Improving transcription with Spoken Terms.

Requires a plan that includes DeepL Voice. Sending a spoken_terms_id on a plan without it is rejected with 403 Forbidden and no style profile is created. A value that is not a valid UUID, or that names a collection your account cannot access, is rejected with 400 Bad Request naming the field.

Example:

"def3a26b-3e84-45b3-84ae-0c0aaf3525f7"

glossary_priority_enabled · boolean · default: false

Whether the glossaries linked to this style profile take priority over its other components. Defaults to false.

Example:

true

Response

201

application/json

Returns the created style profile.

style_profile_id · string<uuid> · required

A unique ID assigned to a style profile.

Example:

"3f1c9d0e-7a24-4b58-9c31-8f0e5d2a1b47"

name · string · required

Name associated with the style profile. At most 255 characters. A style profile always has a name, so it cannot be cleared once it is set.

Example:

"Legal, German"

glossary_ids · string<uuid>[] · required

The IDs of the glossaries linked to the style profile, in the order they are applied.

Example:

["4d0a2e1c-6b93-4f7a-8d15-2c6e9a3b7f81"]

style_rule_ids · string<uuid>[] · required

The IDs of the style rule lists linked to the style profile, in the order they are applied.

Example:

["bd0a38f3-1831-440b-a8dd-2c702e2325ab"]

translation_memory_ids · string<uuid>[] · required

The IDs of the translation memories linked to the style profile, in the order they are applied. A style profile links at most one translation memory per source language.

Example:

["a74d88fb-ed2a-4943-a664-a4512398b994"]

example_document_ids · string<uuid>[] · required

The IDs of the example documents linked to the style profile, in the order they are applied.

Example:

["9e7b41c2-58da-4a03-b6f1-3c85e0d97a26"]

glossary_priority_enabled · boolean · required

Whether the glossaries linked to the style profile take priority over its other components.

Example:

true

creation_time · string<date-time> · required

The creation time of the style profile in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

Example:

"2026-04-01T16:34:25.223Z"

updated_time · string<date-time> · required

The time of the last update to the style profile in the ISO 8601-1:2019 format (e.g.: 2021-08-03T14:16:18.329Z).

Example:

"2026-08-06T09:12:44.108Z"

description · string

Free-text description of the style profile. At most 1000 characters. Omitted from the response when the style profile has no description.

Example:

"Contract wording for the German market."

industry · string

The industry the style profile is written for. At most 255 characters. Omitted from the response when the style profile has no industry.

Example:

"Legal"

spoken_terms_id · string<uuid>

The ID of the Spoken Terms collection linked to the style profile, applied when the profile is used for speech rather than text. A style profile links at most one collection. Omitted from the response when no collection is linked. Collections are managed with the Spoken Terms endpoints.

Example:

"def3a26b-3e84-45b3-84ae-0c0aaf3525f7"