Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

Body

application/json
title
string
required

Style guide title

Example:

"Web application style guide"

audience
string

Audience description

Example:

"customer-facing"

target_audience
enum<string>

Target audience for the translations.

Available options:
not_specified,
children,
teenager,
young_adults,
adults,
old_adults
Example:

"teenager"

grammatical_person
enum<string>

Preferred grammatical person.

Available options:
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
Example:

"first_person_singular"

vocabulary_type
enum<string>

Vocabulary register the translations should use.

Available options:
not_specified,
popular,
technical,
fictional
Example:

"technical"

business
string

Description of the business

Example:

"We are a travel site that helps customers find the best hotels and flights."

company_branding
string

Company branding to remain consistent.

Example:

"ACME Inc. should never be translated."

formatting
string

Formatting requirements and character limitations.

Example:

"Never use capital letters"

glossary_terms
string

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

Example:

"Apartment, cabin, loft"

grammar_consistency
string

Formal or informal pronouns, consistent conjugation, grammatical gender

Example:

""

literal_translation
string

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

Example:

"Neutral"

overall_tone
string

Tone requirement descriptions

Example:

"Tone should be fun and light"

samples
string

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:

"http://www.myexample.com/my/document/path/to/samples.pdf"

Response

Created

id
string
title
string
created_at
string<date-time>
updated_at
string<date-time>
public_url
string
audience
string
target_audience
string
grammatical_person
string
vocabulary_type
string
business
string
company_branding
string
formatting
string
glossary_terms
string
grammar_consistency
string
literal_translation
string
overall_tone
string
samples
string