Tolgee Octri Demo
POST/v2/projects/{projectId}/keys/{keyId}/screenshots

Upload a screenshot for a localization key

Uploads a screenshot and associates it with a localization key. Send the image in the screenshot multipart field; you can include JSON metadata in info for its location, text, and positions.

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

2 parameters · 2 body fields
keyIdintegerrequired
The int64 identifier of the localization key to associate with the screenshot.
projectIdintegerrequired
The int64 identifier of the project containing the key.

Multipart form data containing the screenshot file and optional JSON metadata.

infoobjectoptional
Optional JSON metadata for the screenshot, including its `location`, associated `text`, and `positions`. Each position specifies integer `height`, `width`, `x`, and `y` values.
screenshotstringrequired
The screenshot image file to upload.

5 status codes
201Returns the created screenshot object, including its identifier, file and thumbnail URLs, dimensions, and key references.
createdAtstringoptional
fileUrlstringrequired
filenamestringrequired
File name, which may be downloaded from the screenshot path. When images are secured. Encrypted timestamp is appended to the filename.
heightintegeroptional
idintegerrequired
keyReferencesarray<object>required
locationstringoptional
middleSizedstringoptional
middleSizedUrlstringoptional
thumbnailstringrequired
Thumbnail file name, which may be downloaded from the screenshot path. When images are secured. Encrypted timestamp is appended to the filename.
thumbnailUrlstringrequired
widthintegeroptional
400Returned when the upload request is invalid or the screenshot file is missing.
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 has no valid authentication.
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 does not have permission to upload screenshots for the key.
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 or key 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 upload request is invalid or the required screenshot field is missing. A 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user lacks access. A 404 is returned when the project or key cannot be found. The keyId path parameter and projectId path parameter must identify the key and its project.