Sign Customiser

Navigation

Dark mode

Customiser languages

Get a language's AI translation

Copy page

Returns the language's most recent AI translation with its progress: the summary the language read carries, plus how many chunks completed, failed or are pending and how many keys were written or flagged for review. Starting and retrying a translation are not available on this API.

GET/api/v3/customisers/{customiser_id}/languages/{language_code}/ai-translation
GETGet a language's AI translation
GET/api/v3/customisers/{customiser_id}/languages/{language_code}/ai-translation

Get a language's AI translation

Returns the language's most recent AI translation with its progress: the summary the language read carries, plus how many chunks completed, failed or are pending and how many keys were written or flagged for review. Starting and retrying a translation are not available on this API. Read-only; requires `customisers:read`. A 404 problem means the customiser or language is not one of this store's, or the language has never had an AI translation.

Authorisation

The Authorization header expects a Bearer token. Generate one on the API keys page in your dashboard.

Path

The customiser id.

The language tag.

Get a language's AI translation

Click Send to see the live response.

Overview

Read-only; requires customisers:read. A 404 problem means the customiser or language is not one of this store's, or the language has never had an AI translation.

Authorisation

Bearer token required. Include it in the Authorization header.

Required scope: customisers:read

Path parameters

customiser_idstringpathrequired

The customiser id.

Example: 1

language_codestringpathrequired

The language tag.

Example: fr

Get a language's AI translation
curl https://web.signcustomiser.com/api/v3/customisers/1/languages/fr/ai-translation \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN'
Response
{
  "data": {
    "object": "language_ai_translation",
    "customiser_id": 42,
    "language_code": "fr",
    "status": "running",
    "cancellable": true,
    "chunks_total": 8,
    "keys_targeted": 184,
    "error_summary": null,
    "started_at": "2026-05-04T09:10:00Z",
    "finished_at": null,
    "created_at": "2026-05-04T09:09:58Z",
    "updated_at": "2026-05-04T09:11:20Z",
    "progress": {
      "chunks_completed": 3,
      "chunks_failed": 0,
      "chunks_pending": 5,
      "keys_written": 70,
      "keys_flagged": 2
    }
  },
  "links": {
    "self": "https://web.signcustomiser.com/api/v3/customisers/42/languages/fr/ai-translation",
    "documentation": "https://www.signcustomiser.com/help/api/"
  },
  "meta": {
    "api_version": "v3",
    "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t"
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.