Tolgee Octri Demo
PUT/v2/projects/{projectId}/ai-prompt-customization

Set project prompt customization

Replaces the project-level prompt customization used to give the AI translator context about a project. Supply description to set the project context; it can contain up to 2,000 characters. Retrieve the customization with GET /v2/projects/{projectId}/ai-prompt-customization to inspect its current value.

1 parameter · 1 body field
projectIdintegerrequired
The integer identifier of the project whose prompt customization to set.

Project-level prompt customization settings.

descriptionstringoptional
The project description used in the prompt that helps AI translator to understand the context of your project.

5 status codes
200Returns the project description used to provide context to the AI translator.
descriptionstringoptional
The project description used in the prompt that helps AI translator to understand the context of your project.
400Returned when the body or a parameter value is invalid, including when `description` exceeds 2,000 characters.
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 unauthenticated.
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 update the project customization.
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 body or a parameter value is invalid; a 401 when authentication is missing or invalid; a 403 when you lack access; and a 404 when the project is not found. description must be between 0 and 2,000 characters. The projectId path parameter must identify the project to update.