Tolgee Octri Demo
POST/v2/organizations/{organizationId}/llm-providers

Create an organization-specific provider

Creates an organization-specific language-model provider. Supply apiUrl, name, and type; type must be one of the supported provider types, and optional string fields have maximum lengths defined by the schema. A 200 response returns the created provider configuration.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 10 body fields
organizationIdintegerrequired
The int64 identifier of the organization in which to create the provider.

Configuration for the organization-specific provider. apiUrl, name, and type are required.

apiKeystringoptional
The provider API key; maximum 511 characters.
apiUrlstringrequired
The provider API URL; maximum 2047 characters.
deploymentstringoptional
The provider deployment value; maximum 255 characters.
formatstringoptional
The provider format value; maximum 255 characters.
keepAlivestringoptional
The provider keep-alive value; maximum 255 characters.
modelstringoptional
The provider model value; maximum 255 characters.
namestringrequired
The provider's name; maximum 255 characters.
prioritystringoptional
Provider priority: LOW or HIGH.
Allowed:LOWHIGH
reasoningEffortstringoptional
The provider reasoning-effort value; maximum 255 characters.
typestringrequired
Provider type: OPENAI, OPENAI_AZURE, TOLGEE, ANTHROPIC, or GOOGLE_AI.
Allowed:OPENAIOPENAI_AZURETOLGEEANTHROPICGOOGLE_AI

5 status codes
200Returns the created provider configuration, including its identifier, name, type, API URL, and configured provider settings.
apiKeystringoptional
apiUrlstringoptional
deploymentstringoptional
formatstringoptional
idintegerrequired
modelstringoptional
namestringrequired
prioritystringoptional
Allowed:LOWHIGH
reasoningEffortstringoptional
typestringrequired
Allowed:OPENAIOPENAI_AZURETOLGEEANTHROPICGOOGLE_AI
400Returned when the request body is invalid, including when required fields are missing or an enum value is not accepted.
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 the authenticated user is not permitted to create providers for the organization.
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 specified organization cannot be 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 is returned when the request is unauthenticated, a 403 when the authenticated user cannot manage providers for the organization, and a 404 when the organization cannot be found. apiUrl, name, and type are required; type must be one of OPENAI, OPENAI_AZURE, TOLGEE, ANTHROPIC, or GOOGLE_AI, and priority must be LOW or HIGH when supplied. The organizationId path parameter must identify an existing organization.