Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KB
Style guides

Create a style guide

Create a new style guide.

post/projects/{project_id}/styleguides

Path parameters

project_idstring required

Project ID

Headers

X-PhraseApp-OTPstring

Two-Factor-Authentication token (optional)

Request body

titlestring required

Style guide title

audiencestring

Audience description

target_audience'not_specified' | 'children' | 'teenager' | 'young_adults' | 'adults' | 'old_adults'

Target audience for the translations.

grammatical_person'not_specified' | 'first_person_singular' | 'second_person_singular' | 'third_person_singular_masculine' | 'third_person_singular_feminine' | 'third_person_singular_neuter' | 'first_person_plural' | 'second_person_plural' | 'third_person_plural'

Preferred grammatical person.

vocabulary_type'not_specified' | 'popular' | 'technical' | 'fictional'

Vocabulary register the translations should use.

businessstring

Description of the business

company_brandingstring

Company branding to remain consistent.

formattingstring

Formatting requirements and character limitations.

glossary_termsstring

List of terms and/or phrases that need to be translated consistently.

grammar_consistencystring

Formal or informal pronouns, consistent conjugation, grammatical gender

literal_translationstring

Can be one of: Cultural/Conversational, Literal, Neutral.

overall_tonestring

Tone requirement descriptions

samplesstring

Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency.

Example request

{
  "title": "Web application style guide",
  "audience": "customer-facing",
  "target_audience": "teenager",
  "grammatical_person": "first_person_singular",
  "vocabulary_type": "technical",
  "business": "We are a travel site that helps customers find the best hotels and flights.",
  "company_branding": "ACME Inc. should never be translated.",
  "formatting": "Never use capital letters",
  "glossary_terms": "Apartment, cabin, loft",
  "literal_translation": "Neutral",
  "overall_tone": "Tone should be fun and light",
  "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}

Response

Created

idstring
titlestring
created_atstring date-time
updated_atstring date-time
public_urlstring
audiencestring
target_audiencestring
grammatical_personstring
vocabulary_typestring
businessstring
company_brandingstring
formattingstring
glossary_termsstring
grammar_consistencystring
literal_translationstring
overall_tonestring
samplesstring

Example response

{
  "public_url": "https://phrase.com/styleguide/my-project/26f065cf597be340",
  "audience": "customer-facing",
  "target_audience": "teenager",
  "grammatical_person": "first_person_singular",
  "vocabulary_type": "technical",
  "business": "We are a travel site that helps customers find the best hotels and flights.",
  "company_branding": "ACME Inc. should never be translated.",
  "formatting": "Never use capital letters",
  "glossary_terms": "Apartment, cabin, loft",
  "grammar_consistency": "",
  "literal_translation": "Neutral",
  "overall_tone": "Tone should be fun and light",
  "samples": "http://www.myexample.com/my/document/path/to/samples.pdf"
}