Skip to content
Figur

Create a Studio Shot draft and generate its review preview

POST
/v1/shots/drafts/generate
curl --request POST \
  --url https://example.com/v1/shots/drafts/generate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "shot_info": { "camera": { "crop": { "kind": "preset", "value": "example" }, "lens": { "kind": "preset", "value": "example" }, "angle": { "kind": "preset", "value": "example" }, "lighting": { "kind": "preset", "value": "example" } }, "presentation": { "pose": "example", "gaze": { "kind": "preset", "value": "example" }, "expression": { "kind": "preset", "value": "example" }, "hair": { "kind": "preset", "value": "example" }, "makeup": { "kind": "preset", "value": "example" }, "garment_presentation": "" } }, "model_image_public_id": "example", "background_public_id": "example", "garment_image_public_ids": [ "example" ] }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
StudioShotDraftCreateRequest

Public input for a client-owned, Admin-reviewable Shot draft.

object
display_name
required
Display Name
string
>= 1 characters <= 128 characters
shot_info
required
StudioShotInfoRequest
object
camera
required
StudioShotCameraFramingRequest
object
crop
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
lens
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
angle
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
lighting
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
presentation
required
StudioShotPresentationRequest
object
pose
required
Pose
string
>= 8 characters <= 320 characters
gaze
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
expression
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
hair
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
makeup
required
One of: discriminator: kind
StudioShotPresetChoiceRequest

One curated Shot vocabulary value, validated fully by Studio.

object
kind
required
Kind
string
Allowed value: preset
value
required
Value
string
>= 1 characters <= 128 characters
garment_presentation
Garment Presentation
string
"" <= 320 characters
model_image_public_id
required
Model Image Public Id
string
>= 26 characters <= 26 characters
background_public_id
required
Background Public Id
string
>= 26 characters <= 26 characters
garment_image_public_ids
required
Garment Image Public Ids
Array<string>
>= 1 items

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
StudioShotDraftAcceptedResponse

Gateway-safe result of Studio draft creation and preview dispatch.

object
request_id
required
Request Id
string
job_id
required
Job Id
string
job_status
required
JobStatus

Job status enum.

string
Allowed values: NOT_STARTED SUCCESS FAILURE IN_PROGRESS
credits_cost
required
Credits Cost
integer
shot_public_id
required
Shot Public Id
string
display_name
required
Display Name
string
status
required
Status
string
Allowed value: draft
Example
{
  "job_status": "NOT_STARTED",
  "status": "draft"
}

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