Tolgee Octri Demo
GET/v2/projects/{projectId}/machine-translation-credit-balance

Get the machine translation credit balance for a project

Retrieves the machine translation credit balance for a project. Use this endpoint to check the project's available credits and bucket size. The extraCreditBalance field is retained for backward compatibility and is always 0.

1 parameter
projectIdintegerrequired
The integer identifier of the project whose machine translation credit balance to retrieve.

5 status codes
200Returns the project's credit balance, bucket size, and extra credit balance. `extraCreditBalance` is always 0 and is retained for backward compatibility.
bucketSizeintegerrequired
creditBalanceintegerrequired
extraCreditBalanceintegerdeprecatedrequired
Customers were able to buy extra credits separately in the past. This option is not available anymore and this field is kept only for backward compatibility purposes and is always 0.
400Returned when the request is invalid.
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 authentication is missing or invalid.
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 you do not have permission to view the project's credit balance.
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 is not 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 is invalid, a 401 when authentication is missing or invalid, a 403 when you lack permission, and a 404 when the project is not found. The projectId path parameter must identify the project whose credit balance you want to retrieve.