Skip to content
Figur

Get one published photography direction

GET
/v1/shots/{public_id}
curl --request GET \
  --url https://example.com/v1/shots/example \
  --header 'Authorization: Bearer <token>'

Return one published Shot, with the assets its preview was built from.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
public_id
required
Public Id
string

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
PublishedShotDetailResponse

One published Shot plus the assets its reference preview was built from.

Exposing sources is a deliberate product decision (spec 2026-07-26, D3): for a Figur-global Shot these are Figur’s own curated recipe assets, and they become visible to every client that can see the Shot.

object
public_id
required
Public Id
string
display_name
required
Display Name
string
reference_preview_url
required
Reference Preview Url
string
shot_info
required
PublishedShotInfoResponse
object
camera
required
PublishedShotCameraFramingResponse
object
crop
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
lens
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
angle
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
lighting
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
presentation
required
PublishedShotPresentationResponse
object
pose
required
Pose
string
gaze
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
expression
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
hair
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
makeup
required
One of: discriminator: kind
ShotPresetChoiceResponse

One curated value in public ShotInfo.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
garment_presentation
required
Garment Presentation
string
shared
Shared

True when this Shot belongs to Figur’s shared library rather than to you. A listing returns both, and only your own can be archived.

boolean
source_kind
Any of:
string
sources
Sources

Model, background, and ordered garment references.

Array<object>
PublishedShotSourceResponse

One asset a published Shot’s reference preview was built from.

position is set for garments only and preserves the authored order.

object
role
required
Role

‘model’ | ‘background’ | ‘garment’.

string
public_id
required
Public Id

The source asset’s ULID.

string
image_url
required
Image Url

Short-lived presigned preview URL.

string
position
Any of:
integer
Example
{
  "shot_info": {
    "camera": {
      "crop": {
        "kind": "preset"
      },
      "lens": {
        "kind": "preset"
      },
      "angle": {
        "kind": "preset"
      },
      "lighting": {
        "kind": "preset"
      }
    },
    "presentation": {
      "gaze": {
        "kind": "preset"
      },
      "expression": {
        "kind": "preset"
      },
      "hair": {
        "kind": "preset"
      },
      "makeup": {
        "kind": "preset"
      }
    }
  },
  "shared": false
}

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"
    }
  ]
}