Skip to main content

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.

Style Guide API Reference 1.0.0

The Style Guide API lets you manage organization-wide writing guidelines that Phrase applies across translations and authored content. A Style Guide is a Markdown document scoped to a single language and versioned on every revision.

Key Features

  • Markdown-first authoring — upload Markdown files; the active version is always the latest revision
  • Multi-language — manage one Style Guide per language
  • Versioning — every revision is stored with optional change notes; previous versions stay accessible
  • Search and filter — find Style Guides by name, description, language, or last-modified date
  • Bulk delete — remove multiple Style Guides in a single call, with per-item success / failure reporting

Base URLs

The Style Guide API is available in multiple regions:
RegionBase URL
EUhttps://eu.phrase.com/styleguide
UShttps://us.phrase.com/styleguide

Quick Start

  1. Exchange your API token for a JWT via the Platform Authentication guide
  2. Create a Style Guide by uploading a Markdown file
  3. Reference the Style Guide by ID in subsequent calls
curl -X POST "https://eu.phrase.com/styleguide/api/v1/styleguides" \
  -H "Authorization: Bearer $JWT" \
  -F language=en-GB \
  -F name="English Style Guide" \
  -F description="Brand voice and grammar rules" \
  -F file=@./style-guide.md
Browse the full operation set, request and response schemas, and per-endpoint examples in the API Documentation section of the left navigation.