# Phrase Developer Hub: English API Reference ## API Reference - [English / API Reference / Strings (300 pages)](https://developers.phrase.com/_llms/en/api-reference/strings.md): Documentation for English / API Reference / Strings. - [English / API Reference / TMS (1800 pages)](https://developers.phrase.com/_llms/en/api-reference/tms.md): Documentation for English / API Reference / TMS. - [English / API Reference / Connectors (69 pages)](https://developers.phrase.com/_llms/en/api-reference/connectors.md): Documentation for English / API Reference / Connectors. ### Overview - [Choose the right Phrase API for your integration](https://developers.phrase.com/en/api/overview.md) - [Principles & Compatibility](https://developers.phrase.com/en/api/principles-and-compatibility.md): Conventions common to Phrase's public REST APIs — error handling, forward compatibility, versioning, pagination, and what your client should depend on. ### Platform #### - [Introduction](https://developers.phrase.com/en/api/platform/introduction.md) #### Overview - [Authentication](https://developers.phrase.com/en/api/platform/authentication.md) #### API Documentation ##### OAuth - [Token Endpoint](https://developers.phrase.com/en/api/platform/oauth/token-endpoint.md): Token Endpoint provides tokens according to **OAuth 2.0/OIDC 1.0** (RFC-6749) specifications and its extension **OAuth 2.0 Token Exchange** (RFC-8693). ##### SCIM - [List resource types](https://developers.phrase.com/en/api/platform/scim/list-resource-types.md): Returns the resource types supported by this SCIM service provider (RFC 7644 Section 4). No authentication is required. - [List schemas](https://developers.phrase.com/en/api/platform/scim/list-schemas.md): Returns all SCIM schemas supported by this service provider (RFC 7643 Section 7, RFC 7644 Section 4). No authentication is required. - [Retrieve service provider configuration](https://developers.phrase.com/en/api/platform/scim/retrieve-service-provider-configuration.md): Returns the SCIM service provider's configuration, including supported features such as filtering, patch operations, and authentication schemes (RFC 7643 Section 5, RFC 7644 Section 4). No authentication is required. - [List users](https://developers.phrase.com/en/api/platform/scim/list-users.md): Returns a paginated list of users belonging to the authenticated organization. - [Create user](https://developers.phrase.com/en/api/platform/scim/create-user.md): Provisions a new user into the authenticated organization using the SCIM `urn:ietf:params:scim:schemas:core:2.0:User` schema. - [Get user](https://developers.phrase.com/en/api/platform/scim/get-user.md): Returns a single user by their Phrase Platform identity UID. - [Update user](https://developers.phrase.com/en/api/platform/scim/update-user.md): Updates a user's attributes. Only fields explicitly provided with a non-null, non-blank value are written — omitted, null, blank, or empty-list fields keep their current values. - [Delete user](https://developers.phrase.com/en/api/platform/scim/delete-user.md): Deprovisions a user from the authenticated organization. - [Update user](https://developers.phrase.com/en/api/platform/scim/update-user-1.md): Partially updates a user's attributes using SCIM PATCH operations (RFC 7644 Section 3.5.2). ### Content Groups #### - [Introduction](https://developers.phrase.com/en/api/control-hub/introduction.md) #### Overview - [Authentication](https://developers.phrase.com/en/api/control-hub/authentication.md) #### API Documentation ##### Groups - [List content groups for the caller's organization](https://developers.phrase.com/en/api/control-hub/groups/list-content-groups-for-the-callers-organization.md) - [Create a content group](https://developers.phrase.com/en/api/control-hub/groups/create-a-content-group.md) - [Get a single content group](https://developers.phrase.com/en/api/control-hub/groups/get-a-single-content-group.md) - [Update a content group](https://developers.phrase.com/en/api/control-hub/groups/update-a-content-group.md) - [Delete a content group](https://developers.phrase.com/en/api/control-hub/groups/delete-a-content-group.md): Deletes the content group and all its object references. - [List references linked to the content group](https://developers.phrase.com/en/api/control-hub/groups/list-references-linked-to-the-content-group.md) ### Language AI #### - [Introduction](https://developers.phrase.com/en/api/language-ai/introduction.md): Learn how to use the Phrase Language AI API to translate content automatically using the best available machine translation engine for your language pair. #### API Documentation ##### Authentication - [Login](https://developers.phrase.com/en/api/language-ai/authentication/login.md): DEPRECATED: Use as a fallback method only - Phrase Platform API tokens should be the preferred way. Returns information about the user with the token to be used in the Authorization header and its expiration date. ##### File translations - [File translations](https://developers.phrase.com/en/api/language-ai/file-translations/file-translations.md): Creates a new file translations request based on multipart/form-data. The translation state can be fetched utilizing a returned UID in the response and a [Metadata](/en/api/language-ai/file-translations/file-processing-metadata) endpoint. It is also possible to download the translated file using t… - [Action result](https://developers.phrase.com/en/api/language-ai/file-translations/action-result.md): Use the Accept header with either `application/octet-stream` to get the file or use `application/json` to get the quality estimation. - [File processing metadata](https://developers.phrase.com/en/api/language-ai/file-translations/file-processing-metadata.md): Allows the fetching of metadata from the processing file. The completed file can be downloaded using the [File download](/en/api/language-ai/file-translations/action-result) endpoint. ##### List Language AI Profiles - [List Language AI Profiles](https://developers.phrase.com/en/api/language-ai/list-language-ai-profiles/list-language-ai-profiles.md): List available Language AI profiles for the user. ##### Text translations - [Text translations](https://developers.phrase.com/en/api/language-ai/text-translations/text-translations.md): Translates the text content utilizing Phrase Language AI capabilities. Can identify the source language, if not provided, and translate the text to the target language. If language identification is requested, system needs to have at least 50 characters. - [Text translations v2](https://developers.phrase.com/en/api/language-ai/text-translations/text-translations-v2.md): Translates the text content utilizing Phrase Language AI capabilities. Can identify the source language, if not provided, and translate the text to the target language. If language identification is requested, system needs to have at least 50 characters. ### Studio #### - [Introduction](https://developers.phrase.com/en/api/studio/introduction.md) #### Overview - [Authentication](https://developers.phrase.com/en/api/studio/authentication.md) #### API Documentation ##### Glossaries - [Get Glossaries](https://developers.phrase.com/en/api/studio/glossaries/get-glossaries.md): Retrieve available glossaries for the authenticated account. Items have newline character between them. ##### Insights - [Get Insights](https://developers.phrase.com/en/api/studio/insights/get-insights.md): Retrieve all insights available to the authenticated account. Insights are named collections of AI-powered prompts that analyze conversation transcripts and meeting recordings; each one groups related prompts (items) under a category such as `Earnings Call` or `Company Presentation`. The response in… ##### Projects - [List Projects](https://developers.phrase.com/en/api/studio/projects/list-projects.md): Retrieve a list of projects for the authenticated account. - [Create Project](https://developers.phrase.com/en/api/studio/projects/create-project.md): Creates an empty project and redirects the client to the upload service to upload files. After upload completion, the service will finalize the project automatically. Direct file uploads are more robust and recommended over providing fileUrls. - [Get Project Details](https://developers.phrase.com/en/api/studio/projects/get-project-details.md): Retrieve detailed information about a specific project - [Delete Project](https://developers.phrase.com/en/api/studio/projects/delete-project.md): Delete a specific project and all its associated recordings and data - [Update Project Settings](https://developers.phrase.com/en/api/studio/projects/update-project-settings.md): Update an existing project's AI model preferences, TTS provider, translation memory / MT profile assignment, and sharing visibility. The endpoint is partial: only fields present in the body are written, so a single field can be changed without resending the rest. Authorization is restricted to the p… ##### Pronunciations - [Get Pronunciations](https://developers.phrase.com/en/api/studio/pronunciations/get-pronunciations.md): Retrieve available pronunciations for the authenticated account ##### Recordings - [Get Recording Status](https://developers.phrase.com/en/api/studio/recordings/get-recording-status.md): Retrieve the processing status of a recording. This endpoint supports three modes: - [Get Recording Output](https://developers.phrase.com/en/api/studio/recordings/get-recording-output.md): Retrieve transcription, translation or dubbing outputs using a single query-driven endpoint. ##### Safe Communications - [Get Safe Communications](https://developers.phrase.com/en/api/studio/safe-communications/get-safe-communications.md): Retrieve available safe communications for the authenticated account ##### Subtitle Profiles - [Get Subtitle Profiles](https://developers.phrase.com/en/api/studio/subtitle-profiles/get-subtitle-profiles.md): Retrieve available subtitle profiles for the authenticated account ##### Subtitles - [Get Subtitle](https://developers.phrase.com/en/api/studio/subtitles/get-subtitle.md): Retrieve the structured subtitle segments of a recording's language track in JSON form (with word-level timings). The response shape mirrors the PUT request body — use this before `PUT` to fetch the current segments, edit the `words` array of the segment(s) you want to change (word-level text and ti… - [Update Subtitle](https://developers.phrase.com/en/api/studio/subtitles/update-subtitle.md): Replace the subtitle segments of a recording's language track. The request body must contain **every** segment in the final state — the endpoint performs a bulk replace, not a partial patch. Any segment you omit is removed from the track. Use this to push subtitle edits made externally (for example,… ### Quality Evaluator #### Latest ##### - [Introduction](https://developers.phrase.com/en/api/quality-evaluator/latest/introduction.md) ##### Overview - [Authentication](https://developers.phrase.com/en/api/quality-evaluator/latest/authentication.md) ##### API Documentation ###### Analytics - [Get analytics](https://developers.phrase.com/en/api/quality-evaluator/latest/analytics/get-analytics.md): Returns aggregated daily evaluation rollup data for the caller's organization. Filtered by optional quality profile and date range. ###### Evaluation - [Evaluate segments](https://developers.phrase.com/en/api/quality-evaluator/latest/evaluation/evaluate-segments.md): Evaluates all segments against the AI Checks resolved from the given Content Group. ###### Quality Profiles - [Get Quality Profile by Content Group](https://developers.phrase.com/en/api/quality-evaluator/latest/quality-profiles/get-quality-profile-by-content-group.md): Returns the Quality Profile for the given Content Group, listing all active rules that have AI check support enabled. The profile is resolved dynamically to reflect the current state of the linked Content Group. #### All ##### - [Introduction](https://developers.phrase.com/en/api/quality-evaluator/all/introduction.md) ##### Overview - [Authentication](https://developers.phrase.com/en/api/quality-evaluator/all/authentication.md) ##### API Documentation ###### AI Checks - [List AI Checks](https://developers.phrase.com/en/api/quality-evaluator/all/ai-checks/list-ai-checks.md): **Deprecated.** Will be removed on October 12, 2026. AI Checks are now managed as Style Guide Rules attached to a Content Group. - [Create AI Check](https://developers.phrase.com/en/api/quality-evaluator/all/ai-checks/create-ai-check.md): **Deprecated.** Will be removed on October 12, 2026. AI Checks are now managed as Style Guide Rules attached to a Content Group. - [Get AI Check](https://developers.phrase.com/en/api/quality-evaluator/all/ai-checks/get-ai-check.md): **Deprecated.** Will be removed on October 12, 2026. AI Checks are now managed as Style Guide Rules attached to a Content Group. - [Update AI Check](https://developers.phrase.com/en/api/quality-evaluator/all/ai-checks/update-ai-check.md): **Deprecated.** Will be removed on October 12, 2026. AI Checks are now managed as Style Guide Rules attached to a Content Group. - [Delete AI Check](https://developers.phrase.com/en/api/quality-evaluator/all/ai-checks/delete-ai-check.md): **Deprecated.** Will be removed on October 12, 2026. AI Checks are now managed as Style Guide Rules attached to a Content Group. - [Update AI Check](https://developers.phrase.com/en/api/quality-evaluator/all/ai-checks/update-ai-check-1.md): **Deprecated.** Will be removed on October 12, 2026. AI Checks are now managed as Style Guide Rules attached to a Content Group. ###### Analytics - [Get analytics](https://developers.phrase.com/en/api/quality-evaluator/all/analytics/get-analytics.md): Returns aggregated daily evaluation rollup data for the caller's organization. Filtered by optional quality profile and date range. ###### Evaluation - [Evaluate segments](https://developers.phrase.com/en/api/quality-evaluator/all/evaluation/evaluate-segments.md): **Deprecated.** Will be removed on October 12, 2026. Use `POST /v3/evaluation` instead. - [Evaluate segments](https://developers.phrase.com/en/api/quality-evaluator/all/evaluation/evaluate-segments-1.md): Evaluates all segments against the AI Checks resolved from the given Content Group. ###### Quality Profiles - [List Quality Profiles](https://developers.phrase.com/en/api/quality-evaluator/all/quality-profiles/list-quality-profiles.md): **Deprecated.** Will be removed on October 12, 2026. Quality Profiles are now managed through Content Groups. Use `GET /v3/qualityProfiles/{contentGroupId}` to retrieve a Quality Profile resolved from a Content Group. - [Create Quality Profile](https://developers.phrase.com/en/api/quality-evaluator/all/quality-profiles/create-quality-profile.md): **Deprecated.** Will be removed on October 12, 2026. Quality Profiles are now managed through Content Groups. - [Get Quality Profile](https://developers.phrase.com/en/api/quality-evaluator/all/quality-profiles/get-quality-profile.md): **Deprecated.** Will be removed on October 12, 2026. Use `GET /v3/qualityProfiles/{contentGroupId}` instead. - [Update Quality Profile](https://developers.phrase.com/en/api/quality-evaluator/all/quality-profiles/update-quality-profile.md): **Deprecated.** Will be removed on October 12, 2026. Quality Profiles are now managed through Content Groups. - [Delete Quality Profile](https://developers.phrase.com/en/api/quality-evaluator/all/quality-profiles/delete-quality-profile.md): **Deprecated.** Will be removed on October 12, 2026. Quality Profiles are now managed through Content Groups. - [Get Quality Profile by Content Group](https://developers.phrase.com/en/api/quality-evaluator/all/quality-profiles/get-quality-profile-by-content-group.md): Returns the Quality Profile for the given Content Group, listing all active rules that have AI check support enabled. The profile is resolved dynamically to reflect the current state of the linked Content Group. ### Style Guides #### - [Introduction](https://developers.phrase.com/en/api/style-guides/introduction.md) #### Overview - [Authentication](https://developers.phrase.com/en/api/style-guides/authentication.md) - [Core Concepts](https://developers.phrase.com/en/api/style-guides/concepts.md) - [Working with Rules](https://developers.phrase.com/en/api/style-guides/rules.md) #### API Documentation ##### Rule - [Create a Rule](https://developers.phrase.com/en/api/style-guides/rule/create-a-rule.md): Creates a Rule for the authenticated organization. - [List Rules](https://developers.phrase.com/en/api/style-guides/rule/list-rules.md): Returns a paginated, sorted list of Rules. Defaults to creation date descending. Filtering by the organization's Control Hub "All Groups" system content group ID also matches Rules with `allContentGroups=true`, since that system content group ID conceptually represents all content groups. - [Get a Rule](https://developers.phrase.com/en/api/style-guides/rule/get-a-rule.md): Returns a Rule by ID. - [Delete a Rule](https://developers.phrase.com/en/api/style-guides/rule/delete-a-rule.md): Permanently deletes a Rule. - [Update a Rule](https://developers.phrase.com/en/api/style-guides/rule/update-a-rule.md): Updates a Rule. Only fields present (non-null) in the request body are applied. ##### Style Guide - [Update a Style Guide (v2)](https://developers.phrase.com/en/api/style-guides/style-guide/update-a-style-guide-v2.md): Updates a Style Guide with a Content Group. When a new file is uploaded, returns 202 with a jobId; poll the **Get update job status** API for the final result. Metadata-only updates return 200 with the updated Style Guide. Content-Type can be omitted for metadata-only updates; use multipart/form-dat… - [Get a Style Guide](https://developers.phrase.com/en/api/style-guides/style-guide/get-a-style-guide.md): Returns a Style Guide. - [Update a Style Guide](https://developers.phrase.com/en/api/style-guides/style-guide/update-a-style-guide.md): **Deprecated** — use `PUT /api/v2/styleguides/{id}` for new integrations. Updates a Style Guide. When a new file is uploaded, returns 202 with a jobId; poll the **Get update job status** API for the final result. Metadata-only updates return 200 with the updated Style Guide. Content-Type can be omit… - [Create a Style Guide (v2)](https://developers.phrase.com/en/api/style-guides/style-guide/create-a-style-guide-v2.md): Creates a Style Guide from a Markdown file with a Content Group. Returns 202 with a jobId; poll the **Get create job status** API for the final result. - [Create a Style Guide](https://developers.phrase.com/en/api/style-guides/style-guide/create-a-style-guide.md): **Deprecated** — use `POST /api/v2/styleguides` for new integrations. Creates a Style Guide from a Markdown file. Returns 202 with a jobId; poll the **Get create job status** API for the final result. - [Delete Style Guides](https://developers.phrase.com/en/api/style-guides/style-guide/delete-style-guides.md): Deletes the listed Style Guides and all of their versions. Partial success is possible; the response reports the deleted count and per-item failures. - [List Style Guides](https://developers.phrase.com/en/api/style-guides/style-guide/list-style-guides.md): Returns a paginated list of Style Guides. Filter by name, language, last-modified range, or last-modified user; sort by name, language, or last-modified date. - [Get update job status](https://developers.phrase.com/en/api/style-guides/style-guide/get-update-job-status.md): Returns the current state of a Style Guide update job. HTTP status is always 200; switch on the body's status field. - [Get create job status](https://developers.phrase.com/en/api/style-guides/style-guide/get-create-job-status.md): Returns the current state of a Style Guide create job. HTTP status is always 200; switch on the body's status field. ## OpenAPI Specs - [phrase-platform](/openapi/phrase-platform.json) - [phrase-strings](/openapi/phrase-strings.json) - [phrase-tms-latest](/openapi/phrase-tms-latest.json) - [phrase-tms-all](/openapi/phrase-tms-all.json) - [phrase-tms-v1](/openapi/phrase-tms-v1.json) - [phrase-tms-v2](/openapi/phrase-tms-v2.json) - [phrase-tms-v3](/openapi/phrase-tms-v3.json) - [phrase-tms-v4](/openapi/phrase-tms-v4.json) - [phrase-control-hub](/openapi/phrase-control-hub.json) - [phrase-language-ai](/openapi/phrase-language-ai.json) - [phrase-studio](/openapi/phrase-studio.json) - [phrase-connectors](/openapi/phrase-connectors.json) - [phrase-quality-evaluator-latest](/openapi/phrase-quality-evaluator-latest.json) - [phrase-quality-evaluator-all](/openapi/phrase-quality-evaluator-all.json) - [phrase-style-guides](/openapi/phrase-style-guides.json)