Skip to content
Figur

List published preset tiles

GET
/v1/presets
curl --request GET \
  --url 'https://example.com/v1/presets?kind=model' \
  --header 'Authorization: Bearer <token>'

List the published preset tiles a catalog-shot picker offers, for kind.

Each tile is {id, image_url, label} ONLY — a preset’s internal spec / ShotInfo never crosses this boundary. model / background resolve from the active catalog entries (GET /v1/catalog/{resource}); shot from studio’s published (active) shot presets. The id is what a POST /v1/catalog-shots request references as model_preset_id / background_preset_id / shot_preset_id.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
kind
required
Kind

Which preset family to list: model | background | shot.

string
Allowed values: model background shot

Which preset family to list: model | background | shot.

Header Parameters

Section titled “Header Parameters”
X-Shopify-Hmac-Sha256
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response V1 List Presets V1 Presets Get
Array<object>
PresetTile

One published preset tile — the minimal shape a picker needs.

Deliberately ONLY {id, image_url, label}: the internal spec / ShotInfo (a preset’s prompt-shaping directives) never crosses this boundary. id is the preset’s ULID — what a POST /v1/catalog-shots request references as model_preset_id / background_preset_id / shot_preset_id.

object
id
required
Id

The preset’s ULID — referenced by a catalog-shot dispatch.

string
image_url
required
Image Url

Short-lived presigned preview URL for the preset tile.

string
label
required
Label

Human-readable preset label for the picker.

string
Examplegenerated
[
  {
    "id": "example",
    "image_url": "example",
    "label": "example"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}