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

Get project prompt customization

Retrieves the project-level prompt customization used to give the AI translator context about a project. Use this endpoint to inspect the current project description before changing it.

1 parameter
projectIdintegerrequired
The integer identifier of the project whose prompt customization to retrieve.

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 a parameter value 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 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 access 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 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. The projectId path parameter must identify the project whose customization you want to retrieve.