REST API Overview#

The Multilocale REST API allows you to manage projects, phrases, and translations programmatically.

Base URL#

https://api.multilocale.com

All endpoints are prefixed with /api/.

Content Type#

All requests and responses use JSON:

Content-Type: application/json
Accept: application/json

Authentication#

Most endpoints require authentication via a token in the Authorization header:

Authorization: Token <base64-encoded-access-token>

See Authentication for details on obtaining tokens.

Some read endpoints (like fetching phrases) also accept an organizationId query parameter as an alternative to token authentication.

Common Response Patterns#

Success#

Successful requests return the resource or array of resources directly:

{
  "_id": "507f1f77bcf86cd799439011",
  "key": "welcome",
  "value": "Welcome!",
  "language": "en"
}

Errors#

Error responses include a status and message:

{
  "status": 400,
  "message": "Missing required field: key"
}

Rate Limiting#

The API does not currently enforce rate limits, but please be reasonable with request volume.

Endpoints Summary#

Endpoint Description
POST /api/login Authenticate and get tokens
POST /api/signup Create a new account
POST /api/refresh-access-token Refresh an expired access token
GET /api/phrases List phrases
POST /api/phrases Create phrases
PUT /api/phrases/:id Update a phrase
DELETE /api/phrases Delete phrases by key
GET /api/projects List projects
GET /api/projects/:id Get a project
POST /api/projects Create a project
PUT /api/projects/:id Update a project
POST /api/translate Translate a string
POST /api/translate-to-all-languages Translate to multiple languages