Skip to main content
POST
/
v3
/
style_rules
Create a style rule list
curl --request POST \
  --url https://api.deepl.com/v3/style_rules \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "language": "de",
  "configured_rules": {
    "dates_and_times": {
      "calendar_era": "use_bc_and_ad",
      "centuries": "spell_out",
      "date_format": "use_dd_period_mm_period_yy_with_leading_zeros_for_single_digit_days_and_months",
      "dates_in_numerical_form": "use_dd_hyphen_mm_hyphen_yyyy",
      "decades": "spell_out",
      "hours_minutes_seconds_separator": "use_colon",
      "hours_minutes_separator": "use_colon_without_spaces",
      "midnight_in_numerals": "use_00_00",
      "single_digit_days_and_months": "do_not_use_leading_zero",
      "single_digit_hours": "do_not_use_leading_zero",
      "time_format": "spell_out_time_in_words",
      "writing_dates": "use_dd_space_spelled_out_month_space_yyyy",
      "years": "use_apostrophe_yy"
    },
    "formatting": {
      "email_address_format": "place_domain_in_parentheses",
      "email_address_website_url": "use_lowercase_for_email_addresses_and_website_urls_except_when_url_includes_case_sensitive_elements",
      "headings_case_style": "use_sentence_case_for_titles_and_headings",
      "phone_number_country_code_format": "use_00_before_country_code",
      "phone_number_format": "do_not_use_spaces",
      "space_between_arabic_numerals_and_unit": "do_not_use",
      "space_between_chinese_and_english": "do_not_use",
      "space_between_chinese_characters_and_arabic_numerals": "do_not_use",
      "titles_headings_punctuation": "do_not_use_colon_at_end_of_titles_or_headings"
    },
    "numbers": {
      "approximate_numbers": "use_kanji_numbers",
      "currency_format": "spell_out",
      "decimal_numbers_less_than_one": "always_use_0_before_decimal_separator",
      "decimal_separator": "use_comma_and_do_not_use_thousands_separator",
      "dimensions_separator": "use_multiplication_sign_between_dimensions_with_space_on_either_side",
      "equation_formula_reference": "always_use_arabic_numerals_to_number_equations_or_formulas_referenced_in_text",
      "kanji_numbers": "use_kanji_numbers_for_numbers_in_phrases_and_counting_method_based_on_native_japanese_readings",
      "large_number_format": "always_use_arabic_numerals",
      "large_sums_of_money": "spell_out_italian_words_milione_and_miliardo",
      "large_sums_of_money_format": "use_amount_followed_by_abbreviation_for_million_or_billion_without_space",
      "list_of_measurements_with_units": "repeat_unit_for_each_measurement_in_list",
      "mathematical_expression_spacing": "use_space_between_elements_of_mathematical_expression_or_equation",
      "number_format": "use_half_width_comma_to_separate_large_numbers_into_units_of_three_except_for_calendar_years_and_use_half_width_period_as_decimal_separator",
      "number_separator": "do_not_use_chinese_comma_to_separate_numbers_indicating_approximate_value",
      "numbers_of_5_digits_or_more": "use_comma_as_decimal_separator_and_period_as_thousands_separator",
      "numbers_up_to_4_digits": "use_comma_as_decimal_separator_and_period_as_thousands_separator",
      "percentage_format": "use_arabic_numerals_followed_by_percent_symbol_without_space",
      "reference_to_symbol": "spell_out_symbol_name_followed_by_symbol_in_parentheses",
      "spelling_out_units": "abbreviate_units_of_measure_when_used_with_numeral_but_spell_out_when_used_without_numeral",
      "temperature_format": "spell_out_unit",
      "thousands_separator": "do_not_use",
      "units_of_measure_spacing": "do_not_use_space_between_numeral_and_unit_of_measure",
      "use_of_hiragana_and_kanji": "use_hiragana_japanese_word_か所_or_か月_when_using_arabic_numerals_in_horizontal_writing_but_use_kanji_japanese_word_箇所_or_箇月_when_using_kanji_numbers",
      "writing_numbers": "always_use_kanji_numbers",
      "zero_format": "use_chinese_word_〇_for_numbering"
    },
    "punctuation": {
      "abbreviations": "do_not_separate_abbreviated_words",
      "acronyms": "do_not_use_periods",
      "ampersand_abbreviation_spacing": "do_not_use_spaces_before_and_after_ampersand_as_part_of_abbreviation",
      "ampersand_usage": "use_english_word_and_except_in_company_names_common_abbreviations_titles_software_code_and_mathematical_equations",
      "apostrophe": "use_curly_apostrophes",
      "bracket": "use_hexagonal_brackets",
      "chinese_mixed_with_english": "do_not_place_english_in_quotation_marks",
      "colon": "use_full_width_colon",
      "colon_between_hours_and_minutes_or_chapters_and_verses": "do_not_use_space_before_or_after_colon",
      "colon_in_heading": "use_space_after_colon_not_before",
      "colon_to_replace_versus_or_to": "do_not_use_space_before_or_after_colon",
      "comma_after_conjunctive_adverbs": "do_not_use",
      "comma_after_i_e_and_e_g": "do_not_use",
      "comma_after_short_introductory_phrase": "do_not_use",
      "comma_and_semicolon": "use_comma_between_clauses",
      "corner_bracket_and_periods": "add_period_after_closing_corner_bracket_at_end_of_sentence",
      "corner_brackets_and_periods": "do_not_add_period_before_closing_corner_bracket_when_sentence_continues",
      "dash": "use_em_dash",
      "ellipsis": "use_ellipsis_character",
      "em_dash": "use_double_em_dash",
      "emphasis": "use_double_corner_brackets",
      "exclamation_marks": "do_not_use",
      "explanatory_note_indicator": "use_double_em_dash",
      "full_sentence_in_round_brackets": "add_period_before_closing_round_bracket",
      "highlighting_specific_expressions": "use_single_curly_quotation_marks",
      "japanese_reference_materials": "use_double_corner_brackets",
      "parentheses_for_supplementary_information": "use_parentheses_without_space_on_either_side",
      "passage_of_time_and_movement_between_locations": "use_double_em_dash",
      "periods_and_commas": "use_full_width_japanese_periods_and_full_width_japanese_commas",
      "periods_in_academic_degrees": "do_not_use",
      "periods_in_direct_quotes": "do_not_use",
      "periods_in_uppercase_initialisms_and_acronyms": "do_not_use",
      "plus_sign_usage": "do_not_use_plus_sign_to_symbolize_english_word_and_unless_it_is_part_of_a_proper_noun",
      "possessives_of_proper_names_ending_in_s_style": "add_apostrophe_only",
      "quotation_mark": "use_curly_quotation_marks",
      "quotation_mark_and_apostrophe": "use_curly_quotation_marks_and_apostrophes",
      "quotation_style": "use_corner_brackets_for_primary_quotations_and_double_corner_brackets_for_secondary_quotations",
      "range_indicator": "use_en_dash_with_spaces",
      "related_phrases_indicator": "use_comma",
      "round_brackets": "use_full_width_round_brackets",
      "salutation": "do_not_use_comma_after_salutation_capitalize_following_word",
      "sentence_break_indicator": "use_em_dash_with_space_on_either_side",
      "serial_comma": "do_not_use",
      "setting_off_non_quoted_phrases": "use_full_width_quotation_marks",
      "slash": "do_not_use_spaces_before_and_after_slashes",
      "slash_usage": "do_not_use_slash_to_symbolize_english_word_or",
      "spacing_and_punctuation": "do_not_use_space",
      "text_in_round_brackets_referring_to_previous_sentence": "add_period_after_closing_round_bracket",
      "text_in_round_brackets_supplementing_preceding_text": "add_period_after_closing_round_bracket",
      "titles_of_books_and_newspapers": "use_double_angle_brackets",
      "titles_of_creative_works_trade_names_laws_and_regulations": "use_single_angle_brackets",
      "uppercase_acronyms": "do_not_use_spaces"
    },
    "spelling_and_grammar": {
      "abbreviating_french_word_numero": "abbreviate_as_n_then_degree_symbol",
      "abbreviation_usage": "do_not_use_abbreviations",
      "accents_and_cedillas": "do_not_use_on_capital_letters",
      "accents_in_verbs_conjugated_like_french_word_céder": "use_acute_accent",
      "accents_with_subject_verb_inversion": "use_acute_accent",
      "active_passive_voice": "use_active_voice_if_subject_is_prominent_and_agent_is_clear",
      "all_caps": "do_not_use_all_caps_except_for_acronyms_initialisms_or_proper_nouns",
      "complete_sentences": "always_write_complete_sentences",
      "compound_nouns": "write_as_one_word",
      "conjunctions": "never_start_sentence_with_coordinating_conjunction",
      "contractions": "do_not_use_contractions",
      "email_address_website_url": "use_lowercase_for_email_addresses_and_website_urls_except_when_url_includes_case_sensitive_elements",
      "established_loanwords": "use_as_is",
      "eszett": "replace_eszett_with_ss",
      "foreign_word_translation": "use_equivalent_expressions_in_chinese",
      "french_verbs_ending_in_eler_and_eter": "transcribe_open_e_sound_by_doubling_next_consonant",
      "i_and_u_with_circumflex_accents": "do_not_use_circumflex_accents_except_in_verbs_and_to_distinguish_homophones",
      "informal_address_pronouns": "capitalize_informal_address_pronouns",
      "latin_abbreviations": "do_not_use_latin_abbreviations",
      "passive_voice": "avoid_passive_voice_when_agent_is_known",
      "past_participle_of_french_word_laisser_followed_by_infinitive": "make_french_word_laisser_agree_with_direct_object_complement_if_it_appears_before_verb",
      "personal_titles": "abbreviate",
      "pluralizing_foreign_words": "use_french_spelling_rules",
      "quotation_modification": "do_not_modify_text_in_quotation_marks",
      "spanish_word_solo": "never_use_acute_accent",
      "special_characters": "never_use_symbols",
      "spelled_out_numbers": "use_hyphens",
      "umlauts": "replace_umlauts_with_ae_oe_ue",
      "unestablished_loanwords": "paraphrase_in_korean"
    },
    "style_and_tone": {
      "abbreviations": "avoid_abbreviations_and_symbols_that_can_be_spelled_out_easily",
      "addressing_non_binary_people": "use_spanish_word_elle",
      "addressing_the_reader": "use_formal_french_word_vous",
      "anglicisms": "avoid_anglicisms_when_there_is_a_french_equivalent",
      "binary_representation_of_gender": "avoid_binary_representation_of_gender_when_gender_neutral_language_can_be_used",
      "call_to_action": "use_calls_to_action",
      "complex_sentences": "avoid_unnecessarily_complex_sentences",
      "country_names": "use_long_form",
      "declarative_endings": "mix_hapsho_and_haeyo_styles",
      "default_first_person_pronoun": "do_not_use_first_person_pronouns",
      "default_second_person_pronoun": "do_not_use_second_person_pronouns",
      "default_third_person_singular_pronoun": "use_feminine_pronoun",
      "directional_language": "do_not_use_directional_language",
      "double_negatives": "do_not_use_double_negatives",
      "formality": "use_casual_tone",
      "gender_neutral_language_readability": "use_generic_masculine_for_common_compound_nouns_if_it_increases_readability",
      "gender_unspecified": "use_both_masculine_and_feminine_forms",
      "gender_unspecified_or_mixed": "use_both_feminine_and_masculine_forms",
      "idioms_colloquialisms_and_culture_specific_references": "do_not_use",
      "inflected_words_masculine_noun_agreement": "place_masculine_nouns_closest_to_inflected_words",
      "instructions_style": "use_imperative",
      "mixing_styles": "do_not_mix_desu_masu_style_and_dearu_style",
      "modal_verbs": "avoid_modal_verbs",
      "person_vs_identity_first_language": "use_identity_first_language",
      "personal_vs_impersonal_style": "use_impersonal_style",
      "positive_vs_negative_language": "use_positive_language",
      "proximity_agreement": "use",
      "reader_action_required": "use_you_must_when_action_is_required_from_reader",
      "redundant_introductory_phrases": "avoid_redundant_introductory_phrases",
      "redundant_phrases": "avoid_relativizing_and_redundant_phrases",
      "referring_to_non_binary_people": "use_the_singular_and_plural_schwa",
      "short_vs_long_words": "use_short_words",
      "simple_words_and_sentences": "use_simple_words_and_sentences_avoid_hard_to_translate_words_and_figures_of_speech",
      "specialized_language": "avoid_specialized_language_unless_text_is_aimed_at_experts",
      "text_position_references": "avoid_directional_terms_as_only_reference_to_position_in_text_specify_exact_position_instead",
      "tone": "use_dearu_style_to_give_impression_content_is_accurate_and_rigorous_or_to_convey_sense_of_confidence_and_reliability",
      "verbal_vs_nominal_style": "use_nominal_style"
    },
    "vocabulary": {
      "abbreviations": "write_original_term_then_abbreviation_and_explanation",
      "loanwords": "add_explanation_to_loanword_if_difficult_to_rephrase"
    }
  },
  "custom_instructions": [
    {
      "label": "<string>",
      "prompt": "<string>",
      "source_language": "<string>"
    }
  ]
}
'
{
  "style_id": "bd0a38f3-1831-440b-a8dd-2c702e2325ab",
  "name": "<string>",
  "creation_time": "2023-11-07T05:31:56Z",
  "updated_time": "2023-11-07T05:31:56Z",
  "language": "de",
  "version": 13,
  "configured_rules": [
    {
      "dates_and_times": {
        "calendar_era": "use_bc_and_ad",
        "centuries": "spell_out",
        "date_format": "use_dd_period_mm_period_yy_with_leading_zeros_for_single_digit_days_and_months",
        "dates_in_numerical_form": "use_dd_hyphen_mm_hyphen_yyyy",
        "decades": "spell_out",
        "hours_minutes_seconds_separator": "use_colon",
        "hours_minutes_separator": "use_colon_without_spaces",
        "midnight_in_numerals": "use_00_00",
        "single_digit_days_and_months": "do_not_use_leading_zero",
        "single_digit_hours": "do_not_use_leading_zero",
        "time_format": "spell_out_time_in_words",
        "writing_dates": "use_dd_space_spelled_out_month_space_yyyy",
        "years": "use_apostrophe_yy"
      },
      "formatting": {
        "email_address_format": "place_domain_in_parentheses",
        "email_address_website_url": "use_lowercase_for_email_addresses_and_website_urls_except_when_url_includes_case_sensitive_elements",
        "headings_case_style": "use_sentence_case_for_titles_and_headings",
        "phone_number_country_code_format": "use_00_before_country_code",
        "phone_number_format": "do_not_use_spaces",
        "space_between_arabic_numerals_and_unit": "do_not_use",
        "space_between_chinese_and_english": "do_not_use",
        "space_between_chinese_characters_and_arabic_numerals": "do_not_use",
        "titles_headings_punctuation": "do_not_use_colon_at_end_of_titles_or_headings"
      },
      "numbers": {
        "approximate_numbers": "use_kanji_numbers",
        "currency_format": "spell_out",
        "decimal_numbers_less_than_one": "always_use_0_before_decimal_separator",
        "decimal_separator": "use_comma_and_do_not_use_thousands_separator",
        "dimensions_separator": "use_multiplication_sign_between_dimensions_with_space_on_either_side",
        "equation_formula_reference": "always_use_arabic_numerals_to_number_equations_or_formulas_referenced_in_text",
        "kanji_numbers": "use_kanji_numbers_for_numbers_in_phrases_and_counting_method_based_on_native_japanese_readings",
        "large_number_format": "always_use_arabic_numerals",
        "large_sums_of_money": "spell_out_italian_words_milione_and_miliardo",
        "large_sums_of_money_format": "use_amount_followed_by_abbreviation_for_million_or_billion_without_space",
        "list_of_measurements_with_units": "repeat_unit_for_each_measurement_in_list",
        "mathematical_expression_spacing": "use_space_between_elements_of_mathematical_expression_or_equation",
        "number_format": "use_half_width_comma_to_separate_large_numbers_into_units_of_three_except_for_calendar_years_and_use_half_width_period_as_decimal_separator",
        "number_separator": "do_not_use_chinese_comma_to_separate_numbers_indicating_approximate_value",
        "numbers_of_5_digits_or_more": "use_comma_as_decimal_separator_and_period_as_thousands_separator",
        "numbers_up_to_4_digits": "use_comma_as_decimal_separator_and_period_as_thousands_separator",
        "percentage_format": "use_arabic_numerals_followed_by_percent_symbol_without_space",
        "reference_to_symbol": "spell_out_symbol_name_followed_by_symbol_in_parentheses",
        "spelling_out_units": "abbreviate_units_of_measure_when_used_with_numeral_but_spell_out_when_used_without_numeral",
        "temperature_format": "spell_out_unit",
        "thousands_separator": "do_not_use",
        "units_of_measure_spacing": "do_not_use_space_between_numeral_and_unit_of_measure",
        "use_of_hiragana_and_kanji": "use_hiragana_japanese_word_か所_or_か月_when_using_arabic_numerals_in_horizontal_writing_but_use_kanji_japanese_word_箇所_or_箇月_when_using_kanji_numbers",
        "writing_numbers": "always_use_kanji_numbers",
        "zero_format": "use_chinese_word_〇_for_numbering"
      },
      "punctuation": {
        "abbreviations": "do_not_separate_abbreviated_words",
        "acronyms": "do_not_use_periods",
        "ampersand_abbreviation_spacing": "do_not_use_spaces_before_and_after_ampersand_as_part_of_abbreviation",
        "ampersand_usage": "use_english_word_and_except_in_company_names_common_abbreviations_titles_software_code_and_mathematical_equations",
        "apostrophe": "use_curly_apostrophes",
        "bracket": "use_hexagonal_brackets",
        "chinese_mixed_with_english": "do_not_place_english_in_quotation_marks",
        "colon": "use_full_width_colon",
        "colon_between_hours_and_minutes_or_chapters_and_verses": "do_not_use_space_before_or_after_colon",
        "colon_in_heading": "use_space_after_colon_not_before",
        "colon_to_replace_versus_or_to": "do_not_use_space_before_or_after_colon",
        "comma_after_conjunctive_adverbs": "do_not_use",
        "comma_after_i_e_and_e_g": "do_not_use",
        "comma_after_short_introductory_phrase": "do_not_use",
        "comma_and_semicolon": "use_comma_between_clauses",
        "corner_bracket_and_periods": "add_period_after_closing_corner_bracket_at_end_of_sentence",
        "corner_brackets_and_periods": "do_not_add_period_before_closing_corner_bracket_when_sentence_continues",
        "dash": "use_em_dash",
        "ellipsis": "use_ellipsis_character",
        "em_dash": "use_double_em_dash",
        "emphasis": "use_double_corner_brackets",
        "exclamation_marks": "do_not_use",
        "explanatory_note_indicator": "use_double_em_dash",
        "full_sentence_in_round_brackets": "add_period_before_closing_round_bracket",
        "highlighting_specific_expressions": "use_single_curly_quotation_marks",
        "japanese_reference_materials": "use_double_corner_brackets",
        "parentheses_for_supplementary_information": "use_parentheses_without_space_on_either_side",
        "passage_of_time_and_movement_between_locations": "use_double_em_dash",
        "periods_and_commas": "use_full_width_japanese_periods_and_full_width_japanese_commas",
        "periods_in_academic_degrees": "do_not_use",
        "periods_in_direct_quotes": "do_not_use",
        "periods_in_uppercase_initialisms_and_acronyms": "do_not_use",
        "plus_sign_usage": "do_not_use_plus_sign_to_symbolize_english_word_and_unless_it_is_part_of_a_proper_noun",
        "possessives_of_proper_names_ending_in_s_style": "add_apostrophe_only",
        "quotation_mark": "use_curly_quotation_marks",
        "quotation_mark_and_apostrophe": "use_curly_quotation_marks_and_apostrophes",
        "quotation_style": "use_corner_brackets_for_primary_quotations_and_double_corner_brackets_for_secondary_quotations",
        "range_indicator": "use_en_dash_with_spaces",
        "related_phrases_indicator": "use_comma",
        "round_brackets": "use_full_width_round_brackets",
        "salutation": "do_not_use_comma_after_salutation_capitalize_following_word",
        "sentence_break_indicator": "use_em_dash_with_space_on_either_side",
        "serial_comma": "do_not_use",
        "setting_off_non_quoted_phrases": "use_full_width_quotation_marks",
        "slash": "do_not_use_spaces_before_and_after_slashes",
        "slash_usage": "do_not_use_slash_to_symbolize_english_word_or",
        "spacing_and_punctuation": "do_not_use_space",
        "text_in_round_brackets_referring_to_previous_sentence": "add_period_after_closing_round_bracket",
        "text_in_round_brackets_supplementing_preceding_text": "add_period_after_closing_round_bracket",
        "titles_of_books_and_newspapers": "use_double_angle_brackets",
        "titles_of_creative_works_trade_names_laws_and_regulations": "use_single_angle_brackets",
        "uppercase_acronyms": "do_not_use_spaces"
      },
      "spelling_and_grammar": {
        "abbreviating_french_word_numero": "abbreviate_as_n_then_degree_symbol",
        "abbreviation_usage": "do_not_use_abbreviations",
        "accents_and_cedillas": "do_not_use_on_capital_letters",
        "accents_in_verbs_conjugated_like_french_word_céder": "use_acute_accent",
        "accents_with_subject_verb_inversion": "use_acute_accent",
        "active_passive_voice": "use_active_voice_if_subject_is_prominent_and_agent_is_clear",
        "all_caps": "do_not_use_all_caps_except_for_acronyms_initialisms_or_proper_nouns",
        "complete_sentences": "always_write_complete_sentences",
        "compound_nouns": "write_as_one_word",
        "conjunctions": "never_start_sentence_with_coordinating_conjunction",
        "contractions": "do_not_use_contractions",
        "email_address_website_url": "use_lowercase_for_email_addresses_and_website_urls_except_when_url_includes_case_sensitive_elements",
        "established_loanwords": "use_as_is",
        "eszett": "replace_eszett_with_ss",
        "foreign_word_translation": "use_equivalent_expressions_in_chinese",
        "french_verbs_ending_in_eler_and_eter": "transcribe_open_e_sound_by_doubling_next_consonant",
        "i_and_u_with_circumflex_accents": "do_not_use_circumflex_accents_except_in_verbs_and_to_distinguish_homophones",
        "informal_address_pronouns": "capitalize_informal_address_pronouns",
        "latin_abbreviations": "do_not_use_latin_abbreviations",
        "passive_voice": "avoid_passive_voice_when_agent_is_known",
        "past_participle_of_french_word_laisser_followed_by_infinitive": "make_french_word_laisser_agree_with_direct_object_complement_if_it_appears_before_verb",
        "personal_titles": "abbreviate",
        "pluralizing_foreign_words": "use_french_spelling_rules",
        "quotation_modification": "do_not_modify_text_in_quotation_marks",
        "spanish_word_solo": "never_use_acute_accent",
        "special_characters": "never_use_symbols",
        "spelled_out_numbers": "use_hyphens",
        "umlauts": "replace_umlauts_with_ae_oe_ue",
        "unestablished_loanwords": "paraphrase_in_korean"
      },
      "style_and_tone": {
        "abbreviations": "avoid_abbreviations_and_symbols_that_can_be_spelled_out_easily",
        "addressing_non_binary_people": "use_spanish_word_elle",
        "addressing_the_reader": "use_formal_french_word_vous",
        "anglicisms": "avoid_anglicisms_when_there_is_a_french_equivalent",
        "binary_representation_of_gender": "avoid_binary_representation_of_gender_when_gender_neutral_language_can_be_used",
        "call_to_action": "use_calls_to_action",
        "complex_sentences": "avoid_unnecessarily_complex_sentences",
        "country_names": "use_long_form",
        "declarative_endings": "mix_hapsho_and_haeyo_styles",
        "default_first_person_pronoun": "do_not_use_first_person_pronouns",
        "default_second_person_pronoun": "do_not_use_second_person_pronouns",
        "default_third_person_singular_pronoun": "use_feminine_pronoun",
        "directional_language": "do_not_use_directional_language",
        "double_negatives": "do_not_use_double_negatives",
        "formality": "use_casual_tone",
        "gender_neutral_language_readability": "use_generic_masculine_for_common_compound_nouns_if_it_increases_readability",
        "gender_unspecified": "use_both_masculine_and_feminine_forms",
        "gender_unspecified_or_mixed": "use_both_feminine_and_masculine_forms",
        "idioms_colloquialisms_and_culture_specific_references": "do_not_use",
        "inflected_words_masculine_noun_agreement": "place_masculine_nouns_closest_to_inflected_words",
        "instructions_style": "use_imperative",
        "mixing_styles": "do_not_mix_desu_masu_style_and_dearu_style",
        "modal_verbs": "avoid_modal_verbs",
        "person_vs_identity_first_language": "use_identity_first_language",
        "personal_vs_impersonal_style": "use_impersonal_style",
        "positive_vs_negative_language": "use_positive_language",
        "proximity_agreement": "use",
        "reader_action_required": "use_you_must_when_action_is_required_from_reader",
        "redundant_introductory_phrases": "avoid_redundant_introductory_phrases",
        "redundant_phrases": "avoid_relativizing_and_redundant_phrases",
        "referring_to_non_binary_people": "use_the_singular_and_plural_schwa",
        "short_vs_long_words": "use_short_words",
        "simple_words_and_sentences": "use_simple_words_and_sentences_avoid_hard_to_translate_words_and_figures_of_speech",
        "specialized_language": "avoid_specialized_language_unless_text_is_aimed_at_experts",
        "text_position_references": "avoid_directional_terms_as_only_reference_to_position_in_text_specify_exact_position_instead",
        "tone": "use_dearu_style_to_give_impression_content_is_accurate_and_rigorous_or_to_convey_sense_of_confidence_and_reliability",
        "verbal_vs_nominal_style": "use_nominal_style"
      },
      "vocabulary": {
        "abbreviations": "write_original_term_then_abbreviation_and_explanation",
        "loanwords": "add_explanation_to_loanword_if_difficult_to_rephrase"
      }
    }
  ],
  "custom_instructions": [
    {
      "label": "Currency custom instruction",
      "prompt": "Have currency symbols before the numerical value (e.g. $100, €100)",
      "source_language": "en"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Name associated with the style rule.

language
enum<string>
required

The language that the style rules are applied to.

Available options:
de,
en,
es,
fr,
it,
ja,
ko,
zh
configured_rules
object

The enabled rules for the style rule list including what option was selected for each rule. This schema combines rules from all supported languages.

custom_instructions
object[]

Array of custom instruction objects

Response

Style rule list created successfully

style_id
string
required

A unique ID assigned to a style rule.

Example:

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

name
string
required

Name associated with the style rule.

creation_time
string<date-time>
required

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

updated_time
string<date-time>
required

The time of the style rule when it was last updated in the ISO 8601-1:2019 format (e.g.: 2022-08-03T14:16:18.329Z).

language
enum<string>
required

The language that the style rules are applied to.

Available options:
de,
en,
es,
fr,
it,
ja,
ko,
zh
version
integer
required

The version of the style rule. Incremented when the style rule is updated.

Example:

13

configured_rules
object[]

List of configured rules enabled for the style rule list.

custom_instructions
object[]

List of custom instructions enabled for the style rule list.