Skip to content
Figur

Dispatch a look (mannequin composite) workflow

POST
/v1/look
 
curl --request POST \
  --url https://example.com/v1/look \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_category": "MALE", "items": [ { "trial_image": "users/abc/trial/shirt-1.jpg", "trial_item_category": "top" } ], "runtime_config": {} }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

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

Request Body required

Section titled “Request Body required ”
Media type application/json
LookRequest

Look (mannequin composite) submission.

object
user_category
Any of:
UserCategory

User gender. Matches studio.schema.common.UserCategory.

string
Allowed values: MALE FEMALE
items
required
Items

One or more trial items to compose into the look.

Array<object>
>= 1 items
TrialItemInput

One trial garment passed to /v1/try-on.

object
trial_image
required
Trial Image

S3 object key of the trial garment image.

string
trial_item_category
required
Trial Item Category

Garment category key (e.g. ‘top’, ‘shirt’, ‘jeans’). See studio.schema.common.TryItemCategory for the full list.

string
runtime_config
Any of:
object
key
additional properties
any

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Successful Response

Media type application/json
WorkflowAcceptedResponse

Returned synchronously from any POST /v1/{name} (202).

object
request_id
required
Request Id

26-char ULID — correlates with the row in request_logs.

string
job_id
required
Any of:
string
status
JobStatus

Studio’s job status at submit time. Almost always NOT_STARTED in this 202.

string
default: NOT_STARTED
Allowed values: NOT_STARTED IN_PROGRESS SUCCESS FAILURE
credits_cost
required
Credits Cost

Credits deducted from the calling client. Refunded automatically on any failure path.

integer
Example 
{
  "status": "NOT_STARTED"
}

422

Section titled “422 ”

Validation Error

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