Developer API v1

Ship translations with confidence.

One place to discover the API surface, choose the right credential, and copy a working request. Start with public exports, or use the OTA delivery API for runtime localization.

Quick startBrowse Developer Hub

Choose an API

Basic auth

Public exports

Use from CI/CD and trusted servers to list projects or download filtered localization files.

View public API →
Bearer token

OTA delivery

Use SDK credentials to fetch signed-invariant manifests and immutable locale artifacts.

View OTA API →
Session cookie

Workspace automation

Use the authenticated dashboard for organization-aware administration and localization workflows.

View workspace API →

Quick start

Make your first request in two minutes.

  1. Create an organization API credential under Settings → Developer.
  2. Store the access key and one-time secret in your CI secret manager.
  3. List projects, then export one locale or wire your SDK to OTA.
List projects
curl --user "$GOLOCALISE_ACCESS_KEY:$GOLOCALISE_SECRET" \
  "http://localhost:3001/api/v1/projects?limit=50"
Export a locale
curl --fail --location \
  --user "$GOLOCALISE_ACCESS_KEY:$GOLOCALISE_SECRET" \
  "http://localhost:3001/api/v1/projects/PROJECT_ID/translations?environment=production&language=ar&namespace=checkout&format=json" \
  --output checkout.ar.json
Read an OTA manifest
curl --fail \
  -H "Authorization: Bearer $GOLOCALISE_SDK_TOKEN" \
  "http://localhost:3001/ota/v1/projects/PROJECT_ID/environments/production/manifest?locale=ar"

Endpoint catalog

Every integration surface, clearly labeled.

Public Developer API

Server-to-server read access for CI, export jobs, and tooling.

Basic auth
GET/api/v1/projectsList active projects in the credential organization.
GET/api/v1/projects/{projectId}/translationsExport published or explicitly selected translation statuses.

OTA delivery API

Read-only, cacheable artifacts consumed by mobile, web, and backend clients.

SDK token
GET/ota/v1/projects/{projectId}/environments/{environmentSlug}/manifestResolve the current release and locale artifact hashes.
GET/ota/v1/projects/{projectId}/environments/{environmentSlug}/releases/{version}/locales/{locale}/{hash}Download an immutable locale artifact.

Workspace API

The signed-in dashboard API. It is useful for internal integrations and custom admin tooling, but is not a public client API.

Session cookie
Projects/api/projectsCreate, list, update, and archive projects.
Structure/api/projects/{projectId}/environments · /languages · /namespaces · /keysRead and manage localization structure.
Translations/api/projects/{projectId}/environments/{environmentSlug}/keys/{keyId}/translationsRead editor data and autosave locale values.
Workflow/api/projects/{projectId}/environments/{environmentSlug}/workflow/*Transition, bulk transition, inspect history, restore revisions, and check eligibility.
Files/api/projects/{projectId}/environments/{environmentSlug}/localization-files/{format}/*Preview/import/export JSON, Apple strings, and Android XML.
Releases/api/projects/{projectId}/environments/{environmentSlug}/releases/*Create, inspect, and rollback immutable release snapshots.
Promotions/api/projects/{projectId}/promotionsPreview, apply, and list environment promotions.
AI/api/projects/{projectId}/environments/{environmentSlug}/languages/{languageId}/ai-suggestionRequest a translation suggestion for a configured target language.
Credentials/api/organizations/{organizationId}/api-credentials · /api/projects/{projectId}/environments/{environmentSlug}/sdk-credentialsManage organization API credentials and SDK tokens.

Security & errors

Safe defaults for production integrations.

Credentials

Basic-auth secrets are server-only. SDK tokens are read-only and may only access published OTA artifacts. Rotate or revoke credentials from Organization Settings.

Responses

400 validation · 401 missing or invalid credential · 403 missing scope · 404 tenant-hidden resource · 429 rate limit.

Caching

OTA responses provide ETag. Cache manifests with revalidation and locale artifacts as immutable content.

Signed-in workspace request
fetch("http://localhost:3001/api/projects/PROJECT_ID/environments/production/languages", {
  credentials: "include",
});

The workspace endpoints use the browser session and inherit organization RBAC. Do not expose session cookies or admin credentials in a public client.

For schemas, filters, examples, and compatibility rules, see the versioned docs/api/v1.md contract in the repository and return to the Developer Hub.