Every endpoint of the MultiLocale REST API, generated from the API itself.
All endpoints are relative to https://api.multilocale.com. Create an API key in your MultiLocale dashboard, then authenticate every request with it.
apiKey — HTTP Basic auth carrying only the API key secret: Authorization: Basic base64(<key secret>).
accessToken — Operator session token issued by the MultiLocale dashboard: Authorization: Token <access token>.
The guides, the CLI and the React and Next.js integration are documented on the developer documentation site.
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.
| Name | In | Type | Description |
|---|---|---|---|
| project | query | string | Project name |
| key | query | string | Phrase key (URL-encoded) |
| language | query | string | |
| fields | query | string | Comma-separated projection of fields to return |
| limit | query | integer | Optional bounded page size (maximum 2001) |
| skip | query | integer | Optional page offset (maximum 10000) |
| sortField | query | string (_id | key | language) | |
| sortDirection | query | string (ASC | DESC) |
| Status | Meaning |
|---|---|
| 200 | Array of phrases |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the phrases:read scope |
| 429 | API key rate limit exceeded |
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.
| Status | Meaning |
|---|---|
| 200 | The upserted phrase, or the array of upserted phrases |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the phrases:write scope |
| 429 | API key rate limit exceeded |
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.
| Name | In | Type | Description |
|---|---|---|---|
| keyrequired | query | string | Phrase key (URL-encoded) |
| projectrequired | query | string | Project name |
| Status | Meaning |
|---|---|
| 200 | The deleted phrases |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the phrases:write scope |
| 404 | Nothing matched |
| 429 | API key rate limit exceeded |
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.
| Name | In | Type | Description |
|---|---|---|---|
| phraseIdrequired | path | string |
| Status | Meaning |
|---|---|
| 200 | The updated phrase |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the phrases:write scope |
| 404 | No such phrase in your organization |
| 429 | API key rate limit exceeded |
List projects
Lists the projects of your organization. Requires the projects:read scope. A key scoped to a project sees only that project.
| Status | Meaning |
|---|---|
| 200 | Array of projects |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the projects:read scope |
| 429 | API key rate limit exceeded |
Create a project
Creates a project in your organization and emits project.created. Requires the projects:write scope.
| Status | Meaning |
|---|---|
| 200 | The created project |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the projects:write scope |
| 429 | API key rate limit exceeded |
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.
| Name | In | Type | Description |
|---|---|---|---|
| projectIdrequired | path | string |
| Status | Meaning |
|---|---|
| 200 | The project |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the projects:read scope |
| 404 | No such project in your organization |
| 429 | API key rate limit exceeded |
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.
| Name | In | Type | Description |
|---|---|---|---|
| projectIdrequired | path | string |
| Status | Meaning |
|---|---|
| 200 | The updated project |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the projects:write scope |
| 404 | No such project in your organization |
| 429 | API key rate limit exceeded |
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.
| Name | In | Type | Description |
|---|---|---|---|
| projectNamerequired | path | string |
| Status | Meaning |
|---|---|
| 200 | The project |
| 401 | Missing or invalid credentials |
| 403 | API key is missing the projects:read scope |
| 404 | No such project in your organization |
| 429 | API key rate limit exceeded |