Tolgee Octri Demo
GET/v2/projects/{projectId}/prompts/default

Get the default project prompt

Retrieves the default prompt configuration for a project. Use this endpoint to get the default provider, template, and prompt context options before configuring or running a prompt.

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

5 status codes
200Returns the default prompt configuration, including its `name` and `providerName`, and any configured template and basic prompt options.
basicPromptOptionsarray<string>optional
namestringrequired
providerNamestringrequired
templatestringoptional
400Bad Request
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
401Unauthorized
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
403Forbidden
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
404Not 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 project identifier is invalid. A 401 is returned when the request is unauthenticated, and a 403 is returned when the authenticated user cannot access the project prompt configuration. A 404 is returned when the project cannot be found; the projectId path parameter must identify the project.