MultiLocale API reference

List phrases

Lists the phrases of your organization. A phrase is one {key, value, language} triple belonging to one or more projects. Filter with project, key and language. Requires the phrases:read scope. A key scoped to a project only ever sees that project's phrases. For stable traversal, set pagination=cursor; the response becomes {items, nextCursor} and is ordered by _id. Pass nextCursor back as cursor until it is null. Existing array responses and offset pagination remain available when cursor pagination is not requested.

Create or update phrases

Upserts one phrase or an array of phrases. Emits phrase.created for rows that did not exist and phrase.updated for rows that did — one event per row, not per request. Requires the phrases:write scope. Send Idempotency-Key to make retries safe for 24 hours.

Delete phrases

Deletes every translation of one key in one project — all languages at once — and emits one phrase.deleted per deleted row. Requires the phrases:write scope. Send Idempotency-Key to make retries safe for 24 hours.

Create or update a batch of phrases

Upserts an array of phrases in one authenticated request and returns the resulting array in input order. Each row emits its own created or updated webhook event. Requires the phrases:write scope. Send Idempotency-Key to make retries safe for 24 hours.

Update a phrase

Replaces a phrase you own and emits phrase.updated. Answers 404 — not 403 — for a phrase belonging to another organization, so ids cannot be probed. Requires the phrases:write scope. Send Idempotency-Key to make retries safe for 24 hours.

List projects

Lists the projects of your organization. Requires the projects:read scope. A key scoped to a project sees only that project.

Create a project

Creates a project in your organization and emits project.created. Requires the projects:write scope. Send Idempotency-Key to make retries safe for 24 hours.

Get a project by id

Answers 404 — not 403 — for a project belonging to another organization, so ids cannot be probed. Requires the projects:read scope.

Update a project

Updates a project you own and emits project.updated. Answers 404 — not 403 — for a project belonging to another organization. Requires the projects:write scope. Send Idempotency-Key to make retries safe for 24 hours.

Get a project by name

Project names are unique per organization, not globally, so the lookup is always scoped to your organization. Requires the projects:read scope.

Read sandbox phrases without authentication

Returns a fixed set of demonstration phrases in the same {key, value, language} shape as authenticated phrase reads. No account, credential, or key is required, so agents can evaluate the API before onboarding. Responses carry the standard RateLimit response headers and the anonymous pacing limit applies.

Start a demonstration asynchronous translation job

Demonstrates the API's asynchronous-job pattern without authentication. The response is 202 Accepted with a Location header pointing at the job resource and a body carrying the job _id and status. Poll the Location URL until the status is succeeded, then read the translations from the job body. The job is deterministic fixture work that completes about two seconds after creation.

Poll a demonstration translation job

Reads the status of a demonstration job started at POST /api/v1/sandbox/translationjobs. While the job runs the status is running; afterwards it is succeeded and the body carries the translated phrases. No authentication is required.