Tolgee Octri Demo
POST/v2/projects/{projectId}/billing/order-translation

Create translation tasks for an agency

Creates professional translation tasks for a project and assigns them to an agency. Provide the agency, invitation setting, and task details; use the query filters to select the keys included in the tasks.

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

6 parameters · 3 body fields
projectIdintegerrequired
The project identifier, as a 64-bit integer.
filterStatearray<string>optional
Include keys whose translations have one or more of these states: `UNTRANSLATED`, `TRANSLATED`, `REVIEWED`, or `DISABLED`.
filterOutdatedbooleanoptional
Include keys whose translations are outdated when set to true.
filterTaskInStatusarray<string>optional
Filter task membership using `taskType,status` values, such as `TRANSLATE,NEVER_IN_TASK`. Status can be `IN_OPEN_TASK`, `NOT_IN_OPEN_TASK`, `HAS_BEEN_IN_TASK`, or `NEVER_IN_TASK`; conditions for different task types are combined with AND.
filterHasSuggestionsbooleanoptional
Include only keys with an active suggestion in the task language when set to true.
filterHasNoSuggestionsbooleanoptional
Include only keys without an active suggestion in the task language when set to true.

Translation order details, including the agency, invitation setting, and tasks to create.

agencyIdintegerrequired
The identifier of the agency receiving the translation tasks.
sendReadOnlyInvitationbooleanrequired
Whether to send a read-only invitation to the agency.
tasksarray<object>required
The tasks to create. Each task includes assignee identifiers, key identifiers, a language identifier, a task type, and a description; optional fields include branch, due date, and name.

5 status codes
200Confirms that the translation order and its tasks were created.
400Returned when required fields are missing or body values fail validation, including an invalid task type or task name length.
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 is not permitted to access the requested resource.
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 does not exist.
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 required body fields are missing or invalid: agencyId, sendReadOnlyInvitation, and tasks are required, and each task must include assignees, description, keys, languageId, and type. type must be TRANSLATE or REVIEW; task names, when supplied, must be 3 to 255 characters, and descriptions must not exceed 2000 characters. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks access, and a 404 when the project or referenced resource does not exist. The projectId path parameter must be a 64-bit integer identifier.