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": "example", "trial_item_category": "example", "garment_title": "example" } ], "runtime_config": {} }'

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
LookRequest

Look (mannequin composite) submission.

object
user_category
Any of:
UserCategory

User gender category.

string
Allowed values: MALE FEMALE
items
required
Items

One or more trial items to compose into the look.

Array<object>
>= 1 items
TrialItemInput

One raw-key trial item retained for the separate /v1/look contract.

object
trial_image
required
Trial Image

S3 object key of the trial garment image.

string
trial_item_category
required
Trial Item Category

Category key of the trial item.

string
garment_title
Any of:
string
runtime_config
Any of:
object
key
additional properties
any

Responses

Section titled “Responses”

202

Section titled “202”

Successful Response

Media typeapplication/json
WorkflowAcceptedResponse

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

object
request_id
required
Request Id

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

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 SUCCESS FAILURE IN_PROGRESS
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 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"
    }
  ]
}