Account API reference

The authenticated caller.

Who am I

GET /me

Auth: API key or access token.

Describes the caller and the credential used. Any valid API key or access token; no scope required.

When to use. First, to check that STORESHOT_API_KEY works and whether it is a test key (credential.environment).

Credits. Free: no credits.

Responses

200 The caller.

Schema Me (application/json).

Headers: X-Request-Id , RateLimit , RateLimit-Policy

Example 200 response

{
  "user": {
    "id": "7d0e1a52-3c4b-4f6e-9a8d-2b1c0f9e8a7d",
    "displayName": "string",
    "avatarUrl": "string",
    "email": "string",
    "createdAt": "2026-10-21T12:00:00.000Z"
  },
  "credential": {
    "type": "user_token",
    "environment": "live",
    "scopes": [
      "generations:write"
    ],
    "apiKey": {
      "id": "7d0e1a52-3c4b-4f6e-9a8d-2b1c0f9e8a7d",
      "name": "string",
      "prefix": "string",
      "expiresAt": "2026-10-21T12:00:00.000Z"
    }
  }
}

400 INVALID_INPUT. A credential sent in the query string is refused before authentication, without RateLimit headers.

Schema ErrorEnvelope (application/json).

Headers: X-Request-Id , RateLimit , RateLimit-Policy

401 UNAUTHORIZED: missing, malformed, unknown, revoked or expired credential.

Schema ErrorEnvelope (application/json).

Headers: X-Request-Id

403 FORBIDDEN: see details.reason.

Schema ErrorEnvelope (application/json).

Headers: X-Request-Id , RateLimit , RateLimit-Policy

429 RATE_LIMITED: the request rate of the API key (details.scope key) or of the account (user) is exhausted for this window, or too many failed authentication attempts came from this IP (no details.scope and no RateLimit headers). Retry after Retry-After seconds.

Schema ErrorEnvelope (application/json).

Headers: X-Request-Id , RateLimit , RateLimit-Policy , Retry-After

default Error (see ErrorEnvelope and /v1/docs/errors).

Schema ErrorEnvelope (application/json).

Headers: X-Request-Id , RateLimit , RateLimit-Policy