Skip to main content
POST
/
api
/
v1
/
styleguides
Create a Style Guide
curl --request POST \
  --url https://eu.phrase.com/styleguide/api/v1/styleguides \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file'
{
  "jobId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developers.phrase.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT from IDM (Authorization: Bearer )

Query Parameters

​
language
string
required

Language locale code (e.g., en, en-GB, sv-SE)

Minimum string length: 1
​
name
string
required

Name for the initial version

Maximum string length: 50
​
description
string

Description for the initial version

Maximum string length: 250
​
includeVersions
boolean
default:false

Whether to include versions in the Style Guide response when polling the async create job status

Body

multipart/form-data
​
file
file
required

Style Guide file in Markdown format. Maximum size: 150 KiB.

Response

Job accepted

​
jobId
string