DEdeepl

Create a custom instruction

Changed on

Add a custom instruction to a style rule list to express a style preference that the predefined rules do not cover. Instructions apply to text in the given source language.

post/v3/style_rules/{style_id}/custom_instructions

Request

  • Base URL
    https://api.deepl.com
  • URL
    https://api.deepl.com/v3/style_rules/{style_id}/custom_instructions
  • Auth
    API key in header Authorization

Path parameters

style_idstring required

The ID of the style rule list

Request body

labelstring required

Label for the custom instruction

promptstring required

Instruction text

source_languagestring

Optional source language code

Response

Custom instruction created successfully

idstring required

Unique identifier for the custom instruction

labelstring required

Name associated with the custom instruction

promptstring required

Prompt of the custom instruction

source_languagestring

Optional source language of the custom instruction

Example response

{
  "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

  • c7c91cfac5c0Revision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status