---
title: "Discover the Spoonjoy API"
method: GET
path: "/api/v1"
tags: ["Discovery"]
---

# Discover the Spoonjoy API

`GET /api/v1`

## Request

- Base URL: `https://spoonjoy.app`
- URL: `https://spoonjoy.app/api/v1`
- Auth: none required

## Headers

- `X-Request-Id` string

## Response `200`

Success

- DiscoveryEnvelope
  - `ok` unknown, required
  - `requestId` string, required
  - `data` DiscoveryData, required
    - `app` 'spoonjoy', required
    - `version` 'v1', required
    - `status` 'ok', required
    - `docsUrl` string, required
    - `openapiUrl` string, required
    - `sdkOpenapiUrl` string, required
    - `connectorOpenapiUrl` string, required
    - `resources` object[], required
    - `photoVariants` object, required
      - `queryParameter` 'w', required: Query parameter that asks a Spoonjoy-hosted /photos/ URL for a size variant.
      - `widths` integer[], required: Stored variant widths in pixels. A requested width rounds up to the next one and is capped at the largest.
      - `contentType` 'image/webp', required
      - `note` string, required
    - `auth` object, required

## Other responses

- `400`: Errors: validation_error
- `401`: Errors: invalid_token
- `405`: Errors: method_not_allowed
- `429`: Errors: rate_limited
- `500`: Errors: internal_error
- `503`: Errors: temporarily_unavailable

---

[API](https://skmtc.dev/spoonjoy/apis/spoonjoy-api.md) · [All operations](https://skmtc.dev/spoonjoy/apis/spoonjoy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spoonjoy/apis/spoonjoy-api/revisions/b96eb5d4697d?raw)