Create new key

POST 
/v2/projects/:projectId/keys

Create new key

Request

Path Parameters

projectId int64required

application/json

Body

required

name stringrequired

Name of the key

namespace string
translations object
property name* string
states object

Translation states to update, if not provided states won't be modified

property name* string

Translation states to update, if not provided states won't be modified

tags string[]
screenshotUploadedImageIds int64[]

Ids of screenshots uploaded with /v2/image-upload endpoint

screenshots object[]
Array [
text string
uploadedImageId int64required
Ids of screenshot uploaded with /v2/image-upload endpoint
positions object[]
Array [
x int32required
y int32required
width int32required
height int32required
]
]
relatedKeysInOrder object[]
Keys in the document used as a context for machine translation. Keys in the same order as they appear in the document. The order is important! We are using it for graph distance calculation.
Array [
namespace string
keyName stringrequired
]
description string

Possible values: <= 2000 characters

Description of the key

isPlural booleanrequired

If key is pluralized. If it will be reflected in the editor

pluralArgName string

The argument name for the plural. If null, value will be guessed from the values provided in translations.

Responses

201

Created

*/*

Schema

Schema

id int64required

Id of key record

name stringrequired

Name of key

namespace string

Namespace of key

description string

Description of key

translations objectrequired

Translations object containing values updated in this request

property name* TranslationModel

Translations object containing values updated in this request

id int64required

Id of translation record

text string

Translation text

state stringrequired

Possible values: [UNTRANSLATED, TRANSLATED, REVIEWED, DISABLED]

State of translation

outdated booleanrequired

Whether base language translation was changed after this translation was updated

auto booleanrequired

Was translated using Translation Memory or Machine translation service?

mtProvider string

Possible values: [GOOGLE, AWS, DEEPL, AZURE, BAIDU, TOLGEE]

Which machine translation service was used to auto translate this

tags object[]required
Tags of key
Array [
id int64required
name stringrequired
]
screenshots object[]required
Screenshots of the key
Array [
id int64required
filename stringrequired
File name, which may be downloaded from the screenshot path.
When images are secured. Encrypted timestamp is appended to the filename.
thumbnail stringrequired
Thumbnail file name, which may be downloaded from the screenshot path.
When images are secured. Encrypted timestamp is appended to the filename.
fileUrl stringrequired
thumbnailUrl stringrequired
createdAt date-time
keyReferences object[]required
Array [
keyId int64required
position object
x int32required
y int32required
width int32required
height int32required
keyName stringrequired
keyNamespace string
originalText string
]
location string
width int32
height int32
]
isPlural booleanrequired

If key is pluralized. If it will be reflected in the editor

pluralArgName string

The argument name for the plural

custom objectrequired

Custom values of the key

property name* object

Custom values of the key

Example (from schema)

{
  "id": 0,
  "name": "this_is_super_key",
  "namespace": "homepage",
  "description": "This key is used on homepage. It's a label of sign up button.",
  "translations": {
    "en": {
      "id": 100000003,
      "text": "This is super translation!"
    }
  },
  "tags": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "screenshots": [
    {
      "id": 0,
      "filename": "string",
      "thumbnail": "string",
      "fileUrl": "string",
      "thumbnailUrl": "string",
      "createdAt": "2024-12-16T15:35:47.264Z",
      "keyReferences": [
        {
          "keyId": 0,
          "position": {
            "x": 0,
            "y": 0,
            "width": 0,
            "height": 0
          },
          "keyName": "string",
          "keyNamespace": "string",
          "originalText": "string"
        }
      ],
      "location": "string",
      "width": 0,
      "height": 0
    }
  ],
  "isPlural": true,
  "pluralArgName": "string",
  "custom": {}
}

400

Bad Request

application/json

Schema

Schema

oneOf
ErrorResponseTyped
code stringrequired
Possible values: [unauthenticated, api_access_forbidden, api_key_not_found, invalid_api_key, invalid_project_api_key, project_api_key_expired, bad_credentials, mfa_enabled, invalid_otp_code, mfa_not_enabled, can_not_revoke_own_permissions, data_corrupted, invitation_code_does_not_exist_or_expired, language_tag_exists, language_name_exists, language_not_found, operation_not_permitted, registrations_not_allowed, project_not_found, resource_not_found, scope_not_found, key_exists, third_party_auth_error_message, third_party_auth_no_email, third_party_auth_no_sub, third_party_auth_unknown_error, email_already_verified, third_party_unauthorized, third_party_google_workspace_mismatch, username_already_exists, username_or_password_invalid, user_already_has_permissions, user_already_has_role, user_not_found, file_not_image, file_too_big, invalid_timestamp, email_not_verified, missing_callback_url, invalid_jwt_token, expired_jwt_token, general_jwt_error, cannot_find_suitable_address_part, address_part_not_unique, user_is_not_member_of_organization, organization_has_no_other_owner, user_has_no_project_access, user_is_organization_owner, cannot_set_your_own_permissions, user_is_organization_member, property_not_mutable, import_language_not_from_project, existing_language_not_selected, conflict_is_not_resolved, language_already_selected, cannot_parse_file, could_not_resolve_property, cannot_add_more_then_100_languages, no_languages_provided, language_with_base_language_tag_not_found, language_not_from_project, namespace_not_from_project, cannot_delete_base_language, key_not_from_project, max_screenshots_exceeded, translation_not_from_project, can_edit_only_own_comment, request_parse_error, filter_by_value_state_not_valid, import_has_expired, tag_not_from_project, translation_text_too_long, invalid_recaptcha_token, cannot_leave_owning_project, cannot_leave_project_with_organization_role, dont_have_direct_permissions, tag_too_log, too_many_uploaded_images, one_or_more_images_not_found, screenshot_not_of_key, service_not_found, too_many_requests, translation_not_found, out_of_credits, key_not_found, organization_not_found, cannot_find_base_language, base_language_not_found, no_exported_result, cannot_set_your_own_role, only_translate_review_or_view_permission_accepts_view_languages, oauth2_token_url_not_set, oauth2_user_url_not_set, email_already_invited_or_member, price_not_found, invoice_not_from_organization, invoice_not_found, plan_not_found, plan_not_available_any_more, no_auto_translation_method, cannot_translate_base_language, pat_not_found, invalid_pat, pat_expired, operation_unavailable_for_account_type, validation_email_is_not_valid, current_password_required, cannot_create_organization, wrong_current_password, wrong_param_type, expired_super_jwt_token, cannot_delete_your_own_account, cannot_sort_by_this_column, namespace_not_found, namespace_exists, invalid_authentication_method, unknown_sort_property, only_review_permission_accepts_state_change_languages, only_translate_or_review_permission_accepts_translate_languages, cannot_set_language_permissions_for_admin_scope, cannot_set_view_languages_without_translations_view_scope, cannot_set_translate_languages_without_translations_edit_scope, cannot_set_state_change_languages_without_translations_state_edit_scope, language_not_permitted, scopes_has_to_be_set, set_exactly_one_of_scopes_or_type, translation_exists, import_keys_error, provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids, multiple_projects_not_supported, plan_translation_limit_exceeded, feature_not_enabled, license_key_not_found, cannot_set_view_languages_without_for_level_based_permissions, cannot_set_different_translate_and_state_change_languages_for_level_based_permissions, cannot_disable_your_own_account, subscription_not_found, invoice_does_not_have_usage, customer_not_found, subscription_not_active, organization_already_subscribed, organization_not_subscribed, license_key_used_by_another_instance, translation_spending_limit_exceeded, credit_spending_limit_exceeded, seats_spending_limit_exceeded, this_instance_is_already_licensed, big_meta_not_from_project, mt_service_not_enabled, project_not_selected, organization_not_selected, plan_has_subscribers, translation_failed, batch_job_not_found, key_exists_in_namespace, tag_is_blank, execution_failed_on_management_error, translation_api_rate_limit, cannot_finalize_activity, formality_not_supported_by_service, language_not_supported_by_service, rate_limited, pat_access_not_allowed, pak_access_not_allowed, cannot_modify_disabled_translation, azure_config_required, s3_config_required, content_storage_config_required, content_storage_test_failed, content_storage_config_invalid, invalid_connection_string, cannot_create_azure_storage_client, s3_access_key_required, azure_connection_string_required, s3_secret_key_required, cannot_store_file_to_content_storage, unexpected_error_while_publishing_to_content_storage, webhook_responded_with_non_200_status, unexpected_error_while_executing_webhook, content_storage_is_in_use, cannot_set_state_for_missing_translation, no_project_id_provided, license_key_not_provided, subscription_already_canceled, user_is_subscribed_to_paid_plan, cannot_create_free_plan_without_fixed_type, cannot_modify_plan_free_status, key_id_not_provided, free_self_hosted_seat_limit_exceeded, advanced_params_not_supported, plural_forms_not_found_for_language, nested_plurals_not_supported, message_is_not_plural, content_outside_plural_forms, invalid_plural_form, multiple_plurals_not_supported, custom_values_json_too_long, unsupported_po_message_format, plural_forms_data_loss, current_user_does_not_own_image, user_cannot_view_this_organization, user_is_not_owner_of_organization, pak_created_for_different_project, custom_slug_is_only_applicable_for_custom_storage, invalid_slug_format, batch_job_cancellation_timeout, import_failed, cannot_add_more_then_1000_languages, no_data_to_import, multiple_namespaces_mapped_to_single_file, multiple_mappings_for_same_file_language_name, multiple_mappings_for_null_file_language_name, too_many_mappings_for_file, missing_placeholder_in_template, tag_not_found, cannot_parse_encrypted_slack_login_data, slack_workspace_not_found, cannot_fetch_user_details_from_slack, slack_missing_scope, slack_not_connected_to_your_account, slack_invalid_command, slack_not_subscribed_yet, slack_connection_failed, tolgee_account_already_connected, slack_not_configured, slack_workspace_already_connected, slack_connection_error, email_verification_code_not_valid, cannot_subscribe_to_free_plan, plan_auto_assignment_only_for_free_plans, plan_auto_assignment_only_for_private_plans, plan_auto_assignment_organization_ids_not_in_for_organization_ids, task_not_found, task_not_finished, task_not_open, translation_agency_not_found, this_feature_is_not_implemented_in_oss, sso_token_exchange_failed, sso_user_info_retrieval_failed, sso_id_token_expired, sso_user_cannot_create_organization, sso_cant_verify_user, sso_auth_missing_domain, sso_domain_not_found_or_disabled, native_authentication_disabled, invitation_organization_mismatch, user_is_managed_by_organization, cannot_set_sso_provider_missing_fields]
params object[]
ErrorResponseBody
code stringrequired
params object[]

Example (from schema)

{
  "code": "you_did_something_wrong",
  "params": [
    "something",
    "wrong"
  ]
}

401

Unauthorized

application/json

Schema

Schema

oneOf
ErrorResponseTyped
code stringrequired
Possible values: [unauthenticated, api_access_forbidden, api_key_not_found, invalid_api_key, invalid_project_api_key, project_api_key_expired, bad_credentials, mfa_enabled, invalid_otp_code, mfa_not_enabled, can_not_revoke_own_permissions, data_corrupted, invitation_code_does_not_exist_or_expired, language_tag_exists, language_name_exists, language_not_found, operation_not_permitted, registrations_not_allowed, project_not_found, resource_not_found, scope_not_found, key_exists, third_party_auth_error_message, third_party_auth_no_email, third_party_auth_no_sub, third_party_auth_unknown_error, email_already_verified, third_party_unauthorized, third_party_google_workspace_mismatch, username_already_exists, username_or_password_invalid, user_already_has_permissions, user_already_has_role, user_not_found, file_not_image, file_too_big, invalid_timestamp, email_not_verified, missing_callback_url, invalid_jwt_token, expired_jwt_token, general_jwt_error, cannot_find_suitable_address_part, address_part_not_unique, user_is_not_member_of_organization, organization_has_no_other_owner, user_has_no_project_access, user_is_organization_owner, cannot_set_your_own_permissions, user_is_organization_member, property_not_mutable, import_language_not_from_project, existing_language_not_selected, conflict_is_not_resolved, language_already_selected, cannot_parse_file, could_not_resolve_property, cannot_add_more_then_100_languages, no_languages_provided, language_with_base_language_tag_not_found, language_not_from_project, namespace_not_from_project, cannot_delete_base_language, key_not_from_project, max_screenshots_exceeded, translation_not_from_project, can_edit_only_own_comment, request_parse_error, filter_by_value_state_not_valid, import_has_expired, tag_not_from_project, translation_text_too_long, invalid_recaptcha_token, cannot_leave_owning_project, cannot_leave_project_with_organization_role, dont_have_direct_permissions, tag_too_log, too_many_uploaded_images, one_or_more_images_not_found, screenshot_not_of_key, service_not_found, too_many_requests, translation_not_found, out_of_credits, key_not_found, organization_not_found, cannot_find_base_language, base_language_not_found, no_exported_result, cannot_set_your_own_role, only_translate_review_or_view_permission_accepts_view_languages, oauth2_token_url_not_set, oauth2_user_url_not_set, email_already_invited_or_member, price_not_found, invoice_not_from_organization, invoice_not_found, plan_not_found, plan_not_available_any_more, no_auto_translation_method, cannot_translate_base_language, pat_not_found, invalid_pat, pat_expired, operation_unavailable_for_account_type, validation_email_is_not_valid, current_password_required, cannot_create_organization, wrong_current_password, wrong_param_type, expired_super_jwt_token, cannot_delete_your_own_account, cannot_sort_by_this_column, namespace_not_found, namespace_exists, invalid_authentication_method, unknown_sort_property, only_review_permission_accepts_state_change_languages, only_translate_or_review_permission_accepts_translate_languages, cannot_set_language_permissions_for_admin_scope, cannot_set_view_languages_without_translations_view_scope, cannot_set_translate_languages_without_translations_edit_scope, cannot_set_state_change_languages_without_translations_state_edit_scope, language_not_permitted, scopes_has_to_be_set, set_exactly_one_of_scopes_or_type, translation_exists, import_keys_error, provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids, multiple_projects_not_supported, plan_translation_limit_exceeded, feature_not_enabled, license_key_not_found, cannot_set_view_languages_without_for_level_based_permissions, cannot_set_different_translate_and_state_change_languages_for_level_based_permissions, cannot_disable_your_own_account, subscription_not_found, invoice_does_not_have_usage, customer_not_found, subscription_not_active, organization_already_subscribed, organization_not_subscribed, license_key_used_by_another_instance, translation_spending_limit_exceeded, credit_spending_limit_exceeded, seats_spending_limit_exceeded, this_instance_is_already_licensed, big_meta_not_from_project, mt_service_not_enabled, project_not_selected, organization_not_selected, plan_has_subscribers, translation_failed, batch_job_not_found, key_exists_in_namespace, tag_is_blank, execution_failed_on_management_error, translation_api_rate_limit, cannot_finalize_activity, formality_not_supported_by_service, language_not_supported_by_service, rate_limited, pat_access_not_allowed, pak_access_not_allowed, cannot_modify_disabled_translation, azure_config_required, s3_config_required, content_storage_config_required, content_storage_test_failed, content_storage_config_invalid, invalid_connection_string, cannot_create_azure_storage_client, s3_access_key_required, azure_connection_string_required, s3_secret_key_required, cannot_store_file_to_content_storage, unexpected_error_while_publishing_to_content_storage, webhook_responded_with_non_200_status, unexpected_error_while_executing_webhook, content_storage_is_in_use, cannot_set_state_for_missing_translation, no_project_id_provided, license_key_not_provided, subscription_already_canceled, user_is_subscribed_to_paid_plan, cannot_create_free_plan_without_fixed_type, cannot_modify_plan_free_status, key_id_not_provided, free_self_hosted_seat_limit_exceeded, advanced_params_not_supported, plural_forms_not_found_for_language, nested_plurals_not_supported, message_is_not_plural, content_outside_plural_forms, invalid_plural_form, multiple_plurals_not_supported, custom_values_json_too_long, unsupported_po_message_format, plural_forms_data_loss, current_user_does_not_own_image, user_cannot_view_this_organization, user_is_not_owner_of_organization, pak_created_for_different_project, custom_slug_is_only_applicable_for_custom_storage, invalid_slug_format, batch_job_cancellation_timeout, import_failed, cannot_add_more_then_1000_languages, no_data_to_import, multiple_namespaces_mapped_to_single_file, multiple_mappings_for_same_file_language_name, multiple_mappings_for_null_file_language_name, too_many_mappings_for_file, missing_placeholder_in_template, tag_not_found, cannot_parse_encrypted_slack_login_data, slack_workspace_not_found, cannot_fetch_user_details_from_slack, slack_missing_scope, slack_not_connected_to_your_account, slack_invalid_command, slack_not_subscribed_yet, slack_connection_failed, tolgee_account_already_connected, slack_not_configured, slack_workspace_already_connected, slack_connection_error, email_verification_code_not_valid, cannot_subscribe_to_free_plan, plan_auto_assignment_only_for_free_plans, plan_auto_assignment_only_for_private_plans, plan_auto_assignment_organization_ids_not_in_for_organization_ids, task_not_found, task_not_finished, task_not_open, translation_agency_not_found, this_feature_is_not_implemented_in_oss, sso_token_exchange_failed, sso_user_info_retrieval_failed, sso_id_token_expired, sso_user_cannot_create_organization, sso_cant_verify_user, sso_auth_missing_domain, sso_domain_not_found_or_disabled, native_authentication_disabled, invitation_organization_mismatch, user_is_managed_by_organization, cannot_set_sso_provider_missing_fields]
params object[]
ErrorResponseBody
code stringrequired
params object[]

Example (from schema)

{
  "code": "unauthenticated"
}

403

Forbidden

application/json

Schema

Schema

oneOf
ErrorResponseTyped
code stringrequired
Possible values: [unauthenticated, api_access_forbidden, api_key_not_found, invalid_api_key, invalid_project_api_key, project_api_key_expired, bad_credentials, mfa_enabled, invalid_otp_code, mfa_not_enabled, can_not_revoke_own_permissions, data_corrupted, invitation_code_does_not_exist_or_expired, language_tag_exists, language_name_exists, language_not_found, operation_not_permitted, registrations_not_allowed, project_not_found, resource_not_found, scope_not_found, key_exists, third_party_auth_error_message, third_party_auth_no_email, third_party_auth_no_sub, third_party_auth_unknown_error, email_already_verified, third_party_unauthorized, third_party_google_workspace_mismatch, username_already_exists, username_or_password_invalid, user_already_has_permissions, user_already_has_role, user_not_found, file_not_image, file_too_big, invalid_timestamp, email_not_verified, missing_callback_url, invalid_jwt_token, expired_jwt_token, general_jwt_error, cannot_find_suitable_address_part, address_part_not_unique, user_is_not_member_of_organization, organization_has_no_other_owner, user_has_no_project_access, user_is_organization_owner, cannot_set_your_own_permissions, user_is_organization_member, property_not_mutable, import_language_not_from_project, existing_language_not_selected, conflict_is_not_resolved, language_already_selected, cannot_parse_file, could_not_resolve_property, cannot_add_more_then_100_languages, no_languages_provided, language_with_base_language_tag_not_found, language_not_from_project, namespace_not_from_project, cannot_delete_base_language, key_not_from_project, max_screenshots_exceeded, translation_not_from_project, can_edit_only_own_comment, request_parse_error, filter_by_value_state_not_valid, import_has_expired, tag_not_from_project, translation_text_too_long, invalid_recaptcha_token, cannot_leave_owning_project, cannot_leave_project_with_organization_role, dont_have_direct_permissions, tag_too_log, too_many_uploaded_images, one_or_more_images_not_found, screenshot_not_of_key, service_not_found, too_many_requests, translation_not_found, out_of_credits, key_not_found, organization_not_found, cannot_find_base_language, base_language_not_found, no_exported_result, cannot_set_your_own_role, only_translate_review_or_view_permission_accepts_view_languages, oauth2_token_url_not_set, oauth2_user_url_not_set, email_already_invited_or_member, price_not_found, invoice_not_from_organization, invoice_not_found, plan_not_found, plan_not_available_any_more, no_auto_translation_method, cannot_translate_base_language, pat_not_found, invalid_pat, pat_expired, operation_unavailable_for_account_type, validation_email_is_not_valid, current_password_required, cannot_create_organization, wrong_current_password, wrong_param_type, expired_super_jwt_token, cannot_delete_your_own_account, cannot_sort_by_this_column, namespace_not_found, namespace_exists, invalid_authentication_method, unknown_sort_property, only_review_permission_accepts_state_change_languages, only_translate_or_review_permission_accepts_translate_languages, cannot_set_language_permissions_for_admin_scope, cannot_set_view_languages_without_translations_view_scope, cannot_set_translate_languages_without_translations_edit_scope, cannot_set_state_change_languages_without_translations_state_edit_scope, language_not_permitted, scopes_has_to_be_set, set_exactly_one_of_scopes_or_type, translation_exists, import_keys_error, provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids, multiple_projects_not_supported, plan_translation_limit_exceeded, feature_not_enabled, license_key_not_found, cannot_set_view_languages_without_for_level_based_permissions, cannot_set_different_translate_and_state_change_languages_for_level_based_permissions, cannot_disable_your_own_account, subscription_not_found, invoice_does_not_have_usage, customer_not_found, subscription_not_active, organization_already_subscribed, organization_not_subscribed, license_key_used_by_another_instance, translation_spending_limit_exceeded, credit_spending_limit_exceeded, seats_spending_limit_exceeded, this_instance_is_already_licensed, big_meta_not_from_project, mt_service_not_enabled, project_not_selected, organization_not_selected, plan_has_subscribers, translation_failed, batch_job_not_found, key_exists_in_namespace, tag_is_blank, execution_failed_on_management_error, translation_api_rate_limit, cannot_finalize_activity, formality_not_supported_by_service, language_not_supported_by_service, rate_limited, pat_access_not_allowed, pak_access_not_allowed, cannot_modify_disabled_translation, azure_config_required, s3_config_required, content_storage_config_required, content_storage_test_failed, content_storage_config_invalid, invalid_connection_string, cannot_create_azure_storage_client, s3_access_key_required, azure_connection_string_required, s3_secret_key_required, cannot_store_file_to_content_storage, unexpected_error_while_publishing_to_content_storage, webhook_responded_with_non_200_status, unexpected_error_while_executing_webhook, content_storage_is_in_use, cannot_set_state_for_missing_translation, no_project_id_provided, license_key_not_provided, subscription_already_canceled, user_is_subscribed_to_paid_plan, cannot_create_free_plan_without_fixed_type, cannot_modify_plan_free_status, key_id_not_provided, free_self_hosted_seat_limit_exceeded, advanced_params_not_supported, plural_forms_not_found_for_language, nested_plurals_not_supported, message_is_not_plural, content_outside_plural_forms, invalid_plural_form, multiple_plurals_not_supported, custom_values_json_too_long, unsupported_po_message_format, plural_forms_data_loss, current_user_does_not_own_image, user_cannot_view_this_organization, user_is_not_owner_of_organization, pak_created_for_different_project, custom_slug_is_only_applicable_for_custom_storage, invalid_slug_format, batch_job_cancellation_timeout, import_failed, cannot_add_more_then_1000_languages, no_data_to_import, multiple_namespaces_mapped_to_single_file, multiple_mappings_for_same_file_language_name, multiple_mappings_for_null_file_language_name, too_many_mappings_for_file, missing_placeholder_in_template, tag_not_found, cannot_parse_encrypted_slack_login_data, slack_workspace_not_found, cannot_fetch_user_details_from_slack, slack_missing_scope, slack_not_connected_to_your_account, slack_invalid_command, slack_not_subscribed_yet, slack_connection_failed, tolgee_account_already_connected, slack_not_configured, slack_workspace_already_connected, slack_connection_error, email_verification_code_not_valid, cannot_subscribe_to_free_plan, plan_auto_assignment_only_for_free_plans, plan_auto_assignment_only_for_private_plans, plan_auto_assignment_organization_ids_not_in_for_organization_ids, task_not_found, task_not_finished, task_not_open, translation_agency_not_found, this_feature_is_not_implemented_in_oss, sso_token_exchange_failed, sso_user_info_retrieval_failed, sso_id_token_expired, sso_user_cannot_create_organization, sso_cant_verify_user, sso_auth_missing_domain, sso_domain_not_found_or_disabled, native_authentication_disabled, invitation_organization_mismatch, user_is_managed_by_organization, cannot_set_sso_provider_missing_fields]
params object[]
ErrorResponseBody
code stringrequired
params object[]

Example (from schema)

{
  "code": "operation_not_permitted",
  "params": [
    "translations.edit"
  ]
}

404

Not Found

application/json

Schema

Schema

oneOf
ErrorResponseTyped
code stringrequired
Possible values: [unauthenticated, api_access_forbidden, api_key_not_found, invalid_api_key, invalid_project_api_key, project_api_key_expired, bad_credentials, mfa_enabled, invalid_otp_code, mfa_not_enabled, can_not_revoke_own_permissions, data_corrupted, invitation_code_does_not_exist_or_expired, language_tag_exists, language_name_exists, language_not_found, operation_not_permitted, registrations_not_allowed, project_not_found, resource_not_found, scope_not_found, key_exists, third_party_auth_error_message, third_party_auth_no_email, third_party_auth_no_sub, third_party_auth_unknown_error, email_already_verified, third_party_unauthorized, third_party_google_workspace_mismatch, username_already_exists, username_or_password_invalid, user_already_has_permissions, user_already_has_role, user_not_found, file_not_image, file_too_big, invalid_timestamp, email_not_verified, missing_callback_url, invalid_jwt_token, expired_jwt_token, general_jwt_error, cannot_find_suitable_address_part, address_part_not_unique, user_is_not_member_of_organization, organization_has_no_other_owner, user_has_no_project_access, user_is_organization_owner, cannot_set_your_own_permissions, user_is_organization_member, property_not_mutable, import_language_not_from_project, existing_language_not_selected, conflict_is_not_resolved, language_already_selected, cannot_parse_file, could_not_resolve_property, cannot_add_more_then_100_languages, no_languages_provided, language_with_base_language_tag_not_found, language_not_from_project, namespace_not_from_project, cannot_delete_base_language, key_not_from_project, max_screenshots_exceeded, translation_not_from_project, can_edit_only_own_comment, request_parse_error, filter_by_value_state_not_valid, import_has_expired, tag_not_from_project, translation_text_too_long, invalid_recaptcha_token, cannot_leave_owning_project, cannot_leave_project_with_organization_role, dont_have_direct_permissions, tag_too_log, too_many_uploaded_images, one_or_more_images_not_found, screenshot_not_of_key, service_not_found, too_many_requests, translation_not_found, out_of_credits, key_not_found, organization_not_found, cannot_find_base_language, base_language_not_found, no_exported_result, cannot_set_your_own_role, only_translate_review_or_view_permission_accepts_view_languages, oauth2_token_url_not_set, oauth2_user_url_not_set, email_already_invited_or_member, price_not_found, invoice_not_from_organization, invoice_not_found, plan_not_found, plan_not_available_any_more, no_auto_translation_method, cannot_translate_base_language, pat_not_found, invalid_pat, pat_expired, operation_unavailable_for_account_type, validation_email_is_not_valid, current_password_required, cannot_create_organization, wrong_current_password, wrong_param_type, expired_super_jwt_token, cannot_delete_your_own_account, cannot_sort_by_this_column, namespace_not_found, namespace_exists, invalid_authentication_method, unknown_sort_property, only_review_permission_accepts_state_change_languages, only_translate_or_review_permission_accepts_translate_languages, cannot_set_language_permissions_for_admin_scope, cannot_set_view_languages_without_translations_view_scope, cannot_set_translate_languages_without_translations_edit_scope, cannot_set_state_change_languages_without_translations_state_edit_scope, language_not_permitted, scopes_has_to_be_set, set_exactly_one_of_scopes_or_type, translation_exists, import_keys_error, provide_only_one_of_screenshots_and_screenshot_uploaded_image_ids, multiple_projects_not_supported, plan_translation_limit_exceeded, feature_not_enabled, license_key_not_found, cannot_set_view_languages_without_for_level_based_permissions, cannot_set_different_translate_and_state_change_languages_for_level_based_permissions, cannot_disable_your_own_account, subscription_not_found, invoice_does_not_have_usage, customer_not_found, subscription_not_active, organization_already_subscribed, organization_not_subscribed, license_key_used_by_another_instance, translation_spending_limit_exceeded, credit_spending_limit_exceeded, seats_spending_limit_exceeded, this_instance_is_already_licensed, big_meta_not_from_project, mt_service_not_enabled, project_not_selected, organization_not_selected, plan_has_subscribers, translation_failed, batch_job_not_found, key_exists_in_namespace, tag_is_blank, execution_failed_on_management_error, translation_api_rate_limit, cannot_finalize_activity, formality_not_supported_by_service, language_not_supported_by_service, rate_limited, pat_access_not_allowed, pak_access_not_allowed, cannot_modify_disabled_translation, azure_config_required, s3_config_required, content_storage_config_required, content_storage_test_failed, content_storage_config_invalid, invalid_connection_string, cannot_create_azure_storage_client, s3_access_key_required, azure_connection_string_required, s3_secret_key_required, cannot_store_file_to_content_storage, unexpected_error_while_publishing_to_content_storage, webhook_responded_with_non_200_status, unexpected_error_while_executing_webhook, content_storage_is_in_use, cannot_set_state_for_missing_translation, no_project_id_provided, license_key_not_provided, subscription_already_canceled, user_is_subscribed_to_paid_plan, cannot_create_free_plan_without_fixed_type, cannot_modify_plan_free_status, key_id_not_provided, free_self_hosted_seat_limit_exceeded, advanced_params_not_supported, plural_forms_not_found_for_language, nested_plurals_not_supported, message_is_not_plural, content_outside_plural_forms, invalid_plural_form, multiple_plurals_not_supported, custom_values_json_too_long, unsupported_po_message_format, plural_forms_data_loss, current_user_does_not_own_image, user_cannot_view_this_organization, user_is_not_owner_of_organization, pak_created_for_different_project, custom_slug_is_only_applicable_for_custom_storage, invalid_slug_format, batch_job_cancellation_timeout, import_failed, cannot_add_more_then_1000_languages, no_data_to_import, multiple_namespaces_mapped_to_single_file, multiple_mappings_for_same_file_language_name, multiple_mappings_for_null_file_language_name, too_many_mappings_for_file, missing_placeholder_in_template, tag_not_found, cannot_parse_encrypted_slack_login_data, slack_workspace_not_found, cannot_fetch_user_details_from_slack, slack_missing_scope, slack_not_connected_to_your_account, slack_invalid_command, slack_not_subscribed_yet, slack_connection_failed, tolgee_account_already_connected, slack_not_configured, slack_workspace_already_connected, slack_connection_error, email_verification_code_not_valid, cannot_subscribe_to_free_plan, plan_auto_assignment_only_for_free_plans, plan_auto_assignment_only_for_private_plans, plan_auto_assignment_organization_ids_not_in_for_organization_ids, task_not_found, task_not_finished, task_not_open, translation_agency_not_found, this_feature_is_not_implemented_in_oss, sso_token_exchange_failed, sso_user_info_retrieval_failed, sso_id_token_expired, sso_user_cannot_create_organization, sso_cant_verify_user, sso_auth_missing_domain, sso_domain_not_found_or_disabled, native_authentication_disabled, invitation_organization_mismatch, user_is_managed_by_organization, cannot_set_sso_provider_missing_fields]
params object[]
ErrorResponseBody
code stringrequired
params object[]

Example (from schema)

{
  "code": "resource_not_found",
  "params": null
}

Loading...