Upload screenshot

POST 
/v2/projects/:projectId/keys/:keyId/screenshots

Upload screenshot

Request

Path Parameters

keyId int64required
projectId int64required

multipart/form-data

Body

screenshot binaryrequired
info object
text string
positions object[]
Array [
x int32required
y int32required
width int32required
height int32required
]
location string

Responses

201

Created

*/*

Schema

Schema

id int64required
filename stringrequired

File name, which may be downloaded from the screenshot path.

When images are secured. Encrypted timestamp is appended to the filename.

thumbnail stringrequired

Thumbnail file name, which may be downloaded from the screenshot path.

When images are secured. Encrypted timestamp is appended to the filename.

fileUrl stringrequired
thumbnailUrl stringrequired
createdAt date-time
keyReferences object[]required
Array [
keyId int64required
position object
x int32required
y int32required
width int32required
height int32required
keyName stringrequired
keyNamespace string
originalText string
]
location string
width int32
height int32

Example (from schema)

{
  "id": 0,
  "filename": "string",
  "thumbnail": "string",
  "fileUrl": "string",
  "thumbnailUrl": "string",
  "createdAt": "2024-04-27T10:07:49.556Z",
  "keyReferences": [
    {
      "keyId": 0,
      "position": {
        "x": 0,
        "y": 0,
        "width": 0,
        "height": 0
      },
      "keyName": "string",
      "keyNamespace": "string",
      "originalText": "string"
    }
  ],
  "location": "string",
  "width": 0,
  "height": 0
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...