Skip to main content
POST
/
projects
/
{project_id}
/
screenshots
cURL
curl "https://api.phrase.com/v2/projects/:project_id/screenshots" \
  -u USERNAME_OR_ACCESS_TOKEN \
  -X POST \
  -F branch=my-feature-branch \
  -F name=A%20screenshot%20name \
  -F description=A%20screenshot%20description \
  -F filename=@/path/to/my/screenshot.png
{
  "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
}

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
branch
string

specify the branch to use

Example:

"my-feature-branch"

name
string

Name of the screenshot

Example:

"A screenshot name"

description
string

Description of the screenshot

Example:

"A screenshot description"

filename
file

Screenshot file

Example:

"/path/to/my/screenshot.png"

Response

Created

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