Guides
- Getting started
- Authentication
- Pagination
- Usage examples
- Developer Tools
API Documentation
- Accounts
- Authorizations
- Blacklisted Keys
- Branches
- Comment Reactions
- Comment Replies
- Comments
- Custom Metadata
- Distributions
- Documents
- Figma attachments
- Formats
- Glossaries
- Glossary Term Translations
- Glossary Terms
- ICU
- Invitations
- Job Comments
- Job Locales
- Job Template Locales
- Job Templates
- Jobs
- Key's Figma attachments
- Keys
- Linked Keys
- Locale Downloads
- Locales
- Members
- Notification Groups
- Notifications
- Orders
- Organization Job Template Locales
- Organization Job Templates
- Projects
- Quality performance score
- Release Triggers
- Releases
- Repo Sync Events
- Repo Syncs
- Reports
- Screenshot Markers
- Screenshots
- Search
- Spaces
- Style guides
- Tags
- Teams
- Translations
- Uploads
- Users
- Variables
- Versions / History
- Webhook Deliveries
- Webhooks
Style guides
Create a style guide
Create a new style guide.
POST
/
projects
/
{project_id}
/
styleguides
cURL
Copy
Ask AI
curl "https://api.phrase.com/v2/projects/:project_id/styleguides" \
-u USERNAME_OR_ACCESS_TOKEN \
-X POST \
-d '{"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","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \
-H 'Content-Type: application/json'
Copy
Ask AI
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"title": "My Style Guide",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"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"
}
Authorizations
Enter your token in the format token TOKEN
Headers
Two-Factor-Authentication token (optional)
Path Parameters
Project ID
Body
application/json
Response
201
application/json
Created
The response is of type object
.
Was this page helpful?
cURL
Copy
Ask AI
curl "https://api.phrase.com/v2/projects/:project_id/styleguides" \
-u USERNAME_OR_ACCESS_TOKEN \
-X POST \
-d '{"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","grammar_consistency":","literal_translation":"Neutral","overall_tone":"Tone should be fun and light","samples":"http://www.myexample.com/my/document/path/to/samples.pdf"}' \
-H 'Content-Type: application/json'
Copy
Ask AI
{
"id": "abcd1234cdef1234abcd1234cdef1234",
"title": "My Style Guide",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.