Skip to main content
The Style Rules API is currently available only to Pro API subscribers.
The style rules feature allows you to select a set of rules to apply when translating text. These rules make changes to your text according to the selected formatting and spelling conventions. You can create style rules in the UI at https://deepl.com/custom-rules.

​
Get all style rule lists

Get all style rules lists and their meta-information.
  • cURL
  • HTTP Request
Example request: get all style rule lists
curl -X GET 'https://api.deepl.com/v3/style_rules' \
--header 'Authorization: DeepL-Auth-Key [yourAuthKey]'
Example response
{
  "style_rules": [
    {
      "style_id": "a74d88fb-ed2a-4943-a664-a4512398b994",
      "name": "Technical Documentation Rules",
      "creation_time": "2024-10-01T12:34:56Z",
      "updated_time": "2024-10-03T12:34:56Z",
      "language": "EN",
      "version": 8
    }
  ]
}
You can also optionally pass in a detailed query parameter, to retrieve all configured rules and custom instructions per rule list.
Example request: get all style rule lists and their configured rules
curl -X GET 'https://api.deepl.com/v3/style_rules?detailed=true' \
--header 'Authorization: DeepL-Auth-Key [yourAuthKey]'
Example response
{
  "style_rules": [
    {
      "style_id": "a74d88fb-ed2a-4943-a664-a4512398b994",
      "name": "Technical Documentation Rules",
      "creation_time": "2024-10-01T12:34:56Z",
      "updated_time": "2024-10-03T12:34:56Z",
      "language": "EN",
      "version": 8,
      "configured_rules": {
        "numbers": {
            "time_format": "always-use-24-hour-clock"
        },
        "style_and_tone": {
            "instructions_style": "use-imperative",
            "redundant_introductory_words": "avoid-redundant-introductory-words-that-relate-to-current-text"
        }
      },
      "custom_instructions": {
        "label": "My Custom instruction",
        "prompt": "Use a friendly, diplomatic tone"
      }
    }
  ]
}

​
Query parameters

​
detailed
boolean
Determines if the rule list’s configured_rules and custom_instructions should be included in the response body. If detailed parameter is not included, defaults to false.
​
page
int
The index of the first page to return. Default: 0 (the first page). Use with page_size to get the next page of rule lists.
​
page_size
int
The maximum number of style rule lists to return. Default: 10. Minimum: 1. Maximum: 25.