Skip to content
Login

Translations

Get translations
Requires Headless course creation

GET /api/v1/headless/translations/{id}

Use this endpoint to list all translations for a parent course and surface missing/deleted screen differences.

Path parameters

FieldDescriptionOptions
idParent course ID N/A

Examples

curl -X GET "https://api.coassemble.com/api/v1/headless/translations/1234" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Create translation
Requires Headless course creation

POST /api/v1/headless/translation/translate/{id}

Use this endpoint to create a new translation for a course.

Path parameters

FieldDescriptionOptions
idParent course ID N/A

Body properties

FieldTypeDescriptionRequiredDefaultOptions
languagestringTarget language code (for example: es, fr, de)Yes N/A N/A

Examples

curl -X POST "https://api.coassemble.com/api/v1/headless/translation/translate/1234" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "language": "es"
  }'

Set default translation
Requires Headless course creation

POST /api/v1/headless/translation/default/{id}/{language}

Use this endpoint to make a translation the default version of the course.

Path parameters

FieldDescriptionOptions
idParent course ID N/A
languageTarget language code (for example: es, fr, de) N/A

Examples

curl -X POST "https://api.coassemble.com/api/v1/headless/translation/default/1234/es" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Sync translation
Requires Headless course creation

POST /api/v1/headless/translation/sync/{id}/{language}

Use this endpoint to sync a translation with latest source-course screen changes.

Path parameters

FieldDescriptionOptions
idParent course ID N/A
languageTarget language code (for example: es, fr, de) N/A

Examples

curl -X POST "https://api.coassemble.com/api/v1/headless/translation/sync/1234/es" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Delete translation
Requires Headless course creation

DELETE /api/v1/headless/translation/{id}/{language}

Use this endpoint to delete a translation for a parent course and language.

Path parameters

FieldDescriptionOptions
idParent course ID N/A
languageTarget language code (for example: es, fr, de) N/A

Examples

curl -X DELETE "https://api.coassemble.com/api/v1/headless/translation/1234/es" \
  -H "Authorization: Bearer YOUR_API_TOKEN"