v1
latestOpenAPI 3.0.0Proprietary2026-07-26316155742.7 KBCreate a screenshot
Creates a screenshot in a project to provide visual context for in-context translation. Attach translation keys to regions of the uploaded image so translators can see where each string appears in your UI.
This endpoint accepts a multipart/form-data request with a binary file upload, unlike most Phrase API endpoints that use JSON. Use a multipart form client or the -F flag in curl rather than a JSON body.
The screenshot name must be unique within the project (case-insensitive). When name is omitted, it is derived from the uploaded filename. The account must have the Screenshots feature enabled; requests to projects on accounts without it return 403. Creating a screenshot requires a token with the write scope and manage access to the project.
Path parameters
Project ID
Headers
Two-Factor-Authentication token (optional)
Response
Created
Example response
{
"id": "d2e056aa9e70b01121f41693e344f5ee",
"name": "A screenshot name",
"description": "A screenshot description",
"screenshot_url": "http://assets.example.com/screenshot.png",
"created_at": "2015-01-28T09:52:53Z",
"updated_at": "2015-01-28T09:52:53Z",
"markers_count": 0
}