Retrieve style rule lists
Changed onList the style rule lists in your account. Results are paginated. Set detailed to include each list's configured rules and custom instructions.
Request
- Base URLhttps://api.deepl.com
- URLhttps://api.deepl.com/v3/style_rules
- AuthAPI key in header Authorization
Query parameters
The index of the first page to return. Use with page_size to get the next page of rule lists
The maximum number of style rule lists to return.
Determines if the rule list's configured_rules and custom_instructions should be included in the response body.
Response
JSON object containing the style rule lists.
Example response
{
"style_rules": [
{
"style_id": "bd0a38f3-1831-440b-a8dd-2c702e2325ab",
"version": 13,
"configured_rules": {
"style_and_tone": {
"abbreviations": "use_abbreviations_and_symbols",
"short_vs_long_words": "use_short_words"
},
"punctuation": {
"apostrophe": "use_curly_apostrophes"
}
},
"custom_instructions": [
{
"id": "68fdb803-c013-4e67-b62e-1aad0ab519cd",
"label": "Currency custom instruction",
"prompt": "Have currency symbols before the numerical value (e.g. $100, €100)",
"source_language": "en"
}
]
}
]
}Changes
- warning
added the new
arenum value to the//response property for the response status - warning
added the new
bgenum value to the//response property for the response status - warning
added the new
csenum value to the//response property for the response status - warning
added the new
daenum value to the//response property for the response status - warning
added the new
de-CHenum value to the//response property for the response status - warning
added the new
de-DEenum value to the//response property for the response status - warning
added the new
elenum value to the//response property for the response status - warning
added the new
en-GBenum value to the//response property for the response status - warning
added the new
en-USenum value to the//response property for the response status - warning
added the new
es-419enum value to the//response property for the response status - warning
added the new
es-ESenum value to the//response property for the response status - warning
added the new
etenum value to the//response property for the response status - warning
added the new
fienum value to the//response property for the response status - warning
added the new
fr-CAenum value to the//response property for the response status - warning
added the new
fr-FRenum value to the//response property for the response status - warning
added the new
heenum value to the//response property for the response status - warning
added the new
huenum value to the//response property for the response status - warning
added the new
idenum value to the//response property for the response status - warning
added the new
ltenum value to the//response property for the response status - warning
added the new
lvenum value to the//response property for the response status - warning
added the new
nbenum value to the//response property for the response status - warning
added the new
nlenum value to the//response property for the response status - warning
added the new
plenum value to the//response property for the response status - warning
added the new
ptenum value to the//response property for the response status - warning
added the new
pt-BRenum value to the//response property for the response status - warning
added the new
pt-PTenum value to the//response property for the response status - warning
added the new
roenum value to the//response property for the response status - warning
added the new
ruenum value to the//response property for the response status - warning
added the new
skenum value to the//response property for the response status - warning
added the new
slenum value to the//response property for the response status - warning
added the new
svenum value to the//response property for the response status - warning
added the new
thenum value to the//response property for the response status - warning
added the new
trenum value to the//response property for the response status - warning
added the new
ukenum value to the//response property for the response status - warning
added the new
vienum value to the//response property for the response status - warning
added the new
zh-Hansenum value to the//response property for the response status - warning
added the new
zh-Hantenum value to the//response property for the response status - info
added the media type
application/jsonfor the response with the status - info
added the media type
application/jsonfor the response with the status
- warning