Skip to main content

​
Style Guide API Reference

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. Rules are automatically extracted from each Style Guide and can also be created manually — they improve the output quality in AI Translation Agent and MT Optimize.
New integrations should use the v2 endpoints (POST /api/v2/styleguides, PUT /api/v2/styleguides/{id}). The v2 endpoints require a Content Group ID, which enables automatic rule application in TMS projects. The v1 create and update endpoints are deprecated.

​
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
  • Rules — rules extracted automatically from each Style Guide, or created manually; improve AI Translation Agent and MT Optimize output quality
  • Content Group integration — link a Style Guide to a Content Group so TMS projects inherit its rules automatically
  • 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
Active rules are capped at 50, and active rules with AI check enabled are capped at 20, per (Content Group, Language) pair. See Limits for details.

​
Base URLs

The Style Guide API is available in multiple regions:

​
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 with a Content Group ID
  3. Poll the job status endpoint until the job completes
  4. Reference the Style Guide by ID in subsequent calls
The response returns a jobId. Poll Get create job status until status is COMPLETED:
Browse the full operation set, request and response schemas, and per-endpoint examples in the API Documentation section of the left navigation. For a conceptual overview of Style Guides, Rules, and Content Groups, see Core Concepts.