Tolgee Octri Demo
POST/v2/projects/{projectId}/start-batch-job/ai-playground-translate

Run an AI Playground translation batch

Runs an AI Playground translation batch for selected keys and target languages, using the supplied LLM prompt configuration when provided. Supply keyIds and targetLanguageIds, each with at least one identifier, and poll GET /v2/projects/{projectId}/batch-jobs/{id} to monitor progress.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
projectIdintegerrequired
The int64 identifier of the project in which to run the translation batch.

AI Playground translation settings. keyIds and targetLanguageIds are required; llmPrompt can provide prompt configuration.

keyIdsarray<integer>required
Identifiers of the project keys to translate. Must contain at least one identifier.
llmPromptobjectoptional
LLM prompt configuration, including its required `name` and `providerName` and optional prompt settings.
targetLanguageIdsarray<integer>required
Identifiers of the target languages. Must contain at least one identifier.

5 status codes
200Returns the batch job object with its identifier, type, status, progress, total item count, and creation and update times.
activityRevisionIdintegeroptional
The activity revision id, that stores the activity details of the job
authorobjectoptional
createdAtintegerrequired
The time when the job created
errorMessagestringoptional
If the job failed, this is the error message
idintegerrequired
Batch job id
progressintegerrequired
Total items, that have been processed so far
statusstringrequired
Status of the batch job
Allowed:PENDINGRUNNINGSUCCESSFAILEDCANCELLED
totalItemsintegerrequired
Total items
typestringrequired
Type of the batch job
Allowed:AI_PLAYGROUND_TRANSLATEPRE_TRANSLATE_BT_TMMACHINE_TRANSLATEAUTO_TRANSLATEDELETE_KEYSRESTORE_KEYSHARD_DELETE_KEYSSET_TRANSLATIONS_STATECLEAR_TRANSLATIONSCOPY_TRANSLATIONSTAG_KEYSUNTAG_KEYS
updatedAtintegerrequired
The time when the job was last updated (status change)
400Returned when required body fields are missing or the request body fails validation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to run the batch job.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or a referenced resource cannot be found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the request body is missing required fields or fails validation; a 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks access, and a 404 when the project or a referenced resource cannot be found. The projectId path parameter must identify the project to process. keyIds and targetLanguageIds must each contain at least one identifier; if llmPrompt is supplied, it must include name and providerName.