Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

Body

multipart/form-data
filename
file
required

Image file to upload. Accepted formats are JPEG (jpg/jpeg), GIF, and PNG. Maximum file size is 10 MB. Submitting an unsupported format or a file exceeding the size limit returns 422.

branch
string

specify the branch to use

Example:

"my-feature-branch"

name
string

Display name for the screenshot. Must be unique within the project (case-insensitive). When omitted, the name is derived from the uploaded filename.

Example:

"home_screen"

description
string

Optional free-text description of the screenshot.

Example:

"Main landing page hero section"

Response

Created

id
string
name
string
description
string
screenshot_url
string
created_at
string<date-time>
updated_at
string<date-time>
markers_count
integer