Screenshots

Add Screenshot

Required scopes: project.screenshot (Read and Write).

post/projects/{projectId}/screenshots

Request

Path parameters

projectIdinteger required

Project Identifier. Get via List Projects

Request body

storageIdinteger required

Storage Identifier. Get via List Storages.

Storage file must be image in one of the following formats:

  • 'jpeg'
  • 'jpg'
  • 'png'
  • 'gif'
namestring required

Screenshot name

autoTagboolean

Automatically tags screenshot

fileIdinteger

File Identifier. Get via List Files

Note: Must be used together with autoTag. Can't be used with directoryId or branchId in same request

branchIdinteger

Branch identifier. Get via List Branches

Note: Must be used together with autoTag. Can't be used with fileId or directoryId in the same request

directoryIdinteger

Directory Identifier. Get via List Directories

Note: Must be used together with autoTag. Can't be used with fileId or branchId in same request

labelIdsinteger[]

Attach labels to the screenshot. Get label ids via List Labels

Example request

{
  "storageId": 71,
  "name": "translate_with_siri.jpg",
  "fileId": 48,
  "labelIds": [
    1
  ]
}

Response

Screenshot was successfully added

Example response

{
  "data": {
    "id": 2,
    "userId": 6,
    "url": "https://production-enterprise-screenshots.downloads.crowdin.com/992000002/6/2/middle.jpg?X-Amz-Content-Sha256={sha}&X-Amz-Algorithm={algorithm}&X-Amz-Credential={credentials}&X-Amz-Date={date}&X-Amz-SignedHeaders={headers}&X-Amz-Expires={expires}&X-Amz-Signature={signature}",
    "webUrl": "https://production-enterprise-screenshots.downloads.crowdin.com/992000002/6/2/middle.jpg?X-Amz-Content-Sha256={sha}&X-Amz-Algorithm={algorithm}&X-Amz-Credential={credentials}&X-Amz-Date={date}&X-Amz-SignedHeaders={headers}&X-Amz-Expires={expires}&X-Amz-Signature={signature}",
    "name": "translate_with_siri.jpg",
    "size": {
      "width": 267,
      "height": 176
    },
    "tagsCount": 1,
    "tags": [
      {
        "id": 98,
        "screenshotId": 2,
        "stringId": 2822,
        "position": {
          "x": 474,
          "y": 147,
          "width": 490,
          "height": 99
        },
        "createdAt": "2019-09-23T09:35:31+00:00"
      }
    ],
    "labels": [
      1
    ],
    "labelIds": [
      1
    ],
    "createdAt": "2019-09-23T09:29:19+00:00",
    "updatedAt": "2019-09-23T09:29:19+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.