Screenshots API#

List Screenshot Collections#

GET /v1/projects/:id/screenshots — Requires authentication

Returns all screenshot collections for a project.

Path Parameters#

| Name | Type | Required | Description | |------|------|----------|-------------| | id | string | Yes | The project ID. |

Response#

{
  "collections": [
    {
      "collectionId": "col_xyz789",
      "status": "completed",
      "createdAt": "2026-03-25T09:00:00Z",
      "screenshotCount": 30,
      "platforms": ["ios"],
      "locale": "en-US"
    }
  ]
}

Create Screenshot Collection#

POST /v1/projects/:id/screenshots — Requires authentication

Triggers a new screenshot capture. This is an asynchronous operation. Poll the collection status endpoint to check progress.

Path Parameters#

| Name | Type | Required | Description | |------|------|----------|-------------| | id | string | Yes | The project ID. |

Request Body#

| Name | Type | Required | Description | |------|------|----------|-------------| | platforms | string[] | No | Target platforms: 'ios', 'android'. Defaults to the project's platform. | | device_sizes | string[] | No | Device sizes to capture. e.g., ['6.7"', '6.5"', '5.5"']. Defaults to all required sizes. | | locale | string | No | Locale for the screenshots. Defaults to the project's primary locale. |

Response#

{
  "collectionId": "col_xyz789",
  "status": "capturing"
}

Example#

curl -X POST \
  -H "Authorization: Bearer sk_stora_..." \
  -H "Content-Type: application/json" \
  -d '{"platforms": ["ios"], "locale": "en-US"}' \
  https://stora.sh/api/v1/projects/proj_abc123/screenshots

Note: Screenshot generation typically takes 1-3 minutes. The response returns immediately with a collectionId you can use to poll for results.

Get Screenshot Collection#

GET /v1/projects/:id/screenshots/:collectionId — Requires authentication

Returns the status and screenshot URLs for a specific collection.

Path Parameters#

| Name | Type | Required | Description | |------|------|----------|-------------| | id | string | Yes | The project ID. | | collectionId | string | Yes | The collection ID. |

Response (Completed)#

{
  "collectionId": "col_xyz789",
  "status": "completed",
  "createdAt": "2026-03-25T09:00:00Z",
  "screenshots": [
    {
      "url": "https://stora.sh/screenshots/col_xyz789/home-6.7.png",
      "deviceSize": "6.7\"",
      "screenName": "Home",
      "locale": "en-US"
    },
    {
      "url": "https://stora.sh/screenshots/col_xyz789/home-6.5.png",
      "deviceSize": "6.5\"",
      "screenName": "Home",
      "locale": "en-US"
    }
  ]
}

Status Values#

| Status | Description | |---|---| | capturing | The AI agent is navigating the app and taking screenshots. | | processing | Raw captures are being processed into styled screenshots. | | completed | All screenshots are ready and URLs are available. | | failed | Something went wrong. Check the error field for details. |

Example#

curl -H "Authorization: Bearer sk_stora_..." \
  https://stora.sh/api/v1/projects/proj_abc123/screenshots/col_xyz789