Translation keys

Upload translation key screenshot from file

Changed on Nov 12, 2025

Uploads translation key screenshot from a file. It throws an error if translation key does not exist.

The uploaded screenshot replaces the existing screenshot if it exists.

key is a required field, and it cannot be null or empty. The endpoint throws an error if key is null or empty.

namespace is an optional field, and it can be null or empty. Null and empty values are ignored.

If namespace is not provided, then an empty namespace is used.

Max size of screenshot is 4MB for file upload, otherwise, the endpoint throws an error.

Only PNG, JPG and JPEG formats are supported, otherwise, the endpoint may throw an error.

post/api/v1/translation-keys/screenshots/file-upload

Request

Base URL
https://api.simplelocalize.io
Auth
API key in header X-SimpleLocalize-Token
TypeScript
https://skmtc.dev/simplelocalize/apis/simplelocalize-api/docs/api/v1/translation-keys/screenshots/file-upload/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

keystring required

namespacestring

Request body multipart/form-data

filestring binary required

Response

Changes

Nov 12, 20250329534cd557 Revision changes
- warning
  deleted the header request parameter X-SimpleLocalize-Token
- info
  the endpoint scheme security Project API Key was added to the API
- info
  the endpoint scheme security apiKey was removed from the API
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Apr 19, 20255475c7163be9 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (3 revisions)