Tolgee Octri Demo
POST/v2/projects/{projectId}/big-meta

Store Big Meta for a project

Stores Big Meta for a project, including an ordered list of related keys used as context for machine translation. Supply each key in document order because that order is used for graph distance calculations.

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

1 parameter · 1 body field
projectIdintegerrequired
The project identifier, as a 64-bit integer.

Big Meta data for the project, with related keys ordered as they appear in the document.

relatedKeysInOrderarray<object>optional
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.

5 status codes
200Confirms that Big Meta was stored for the project.
400Returned when the request body is invalid or an item in `relatedKeysInOrder` does not include a valid `keyName`.
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 not authenticated.
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 access the requested resource.
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 does not exist.
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 body is invalid; each item in relatedKeysInOrder must include a keyName with at least one character. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks access, and a 404 when the project does not exist. The projectId path parameter must be a 64-bit integer identifier.