Dispatch a complementary-garment-generator workflow

POST

/v1/complementary-garment-generator

curl --request POST \
  --url https://example.com/v1/complementary-garment-generator \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "image_model": "example", "eval_enabled": true, "resolution": "example", "aspect_ratio": "example", "seed": 1, "on_technical_failure": "example", "display_name": "", "garment_category_public_id": "example", "authoring": { "primary_colour": "example", "material": "example", "pattern": "solid", "form": { "preset": "example", "custom_text": "example" }, "length": { "preset": "example", "custom_text": "example" }, "distinctive_details": [ { "preset": "example", "custom_text": "example" } ], "creative_direction": "example" }, "color": "example", "material": "example", "pattern": "example", "fit": "slim", "length": "example", "metadata": {}, "pilot_brand": "example" }'

Authorizations

• sk_*

Parameters

Header Parameters

X-Shopify-Hmac-Sha256

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

ComplementaryGarmentGeneratorRequest

POST /v1/complementary-garment-generator — one styling item.

V3 is canonical. V2 nested authoring and historical flat fields remain mutually exclusive compatibility branches for existing callers.

object

image_model

Any of:

string

string

null

null

eval_enabled

Any of:

boolean

boolean

null

null

resolution

Any of:

string

string

null

null

aspect_ratio

Any of:

string

string

null

null

seed

Any of:

integer

integer

null

null

on_technical_failure

Any of:

string

string

null

null

display_name

Display Name

string

""

garment_category_public_id

required

Garment Category Public Id

ULID of the garment category driving compatibility.

string

authoring

Any of:

ComplementaryItemIntentV3Request

ComplementaryItemIntentV3Request

Compact complementary-item input shared by Admin and Studio.

object

primary_colour

required

Primary Colour

string

>= 1 characters <= 80 characters

material

required

Material

string

>= 1 characters <= 100 characters

pattern

Pattern

string

default: solid >= 1 characters <= 100 characters

form

Any of:

ComplementaryPresetOrCustomRequest

ComplementaryPresetOrCustomRequest

Gateway mirror of one V3 preset-or-custom value.

object

preset

required

Preset

string

>= 1 characters <= 80 characters

custom_text

Any of:

string

string

>= 1 characters <= 120 characters

null

null

null

null

length

Any of:

ComplementaryPresetOrCustomRequest

ComplementaryPresetOrCustomRequest

Gateway mirror of one V3 preset-or-custom value.

object

preset

required

Preset

string

>= 1 characters <= 80 characters

custom_text

Any of:

string

string

>= 1 characters <= 120 characters

null

null

null

null

distinctive_details

Distinctive Details

Array<object>

<= 3 items

ComplementaryPresetOrCustomRequest

Gateway mirror of one V3 preset-or-custom value.

object

preset

required

Preset

string

>= 1 characters <= 80 characters

custom_text

Any of:

string

string

>= 1 characters <= 120 characters

null

null

creative_direction

Any of:

string

string

>= 1 characters <= 280 characters

null

null

ComplementaryItemAuthoringRequest

ComplementaryItemAuthoringRequest

Gateway mirror of Studio’s typed complementary-item authoring brief.

object

color

required

Color

string

>= 1 characters <= 80 characters

material

required

Material

string

>= 1 characters <= 100 characters

pattern

Pattern

string

default: solid >= 1 characters <= 100 characters

accent_color

Any of:

string

string

>= 1 characters <= 80 characters

null

null

silhouette

Any of:

string

string

>= 1 characters <= 120 characters

null

null

fit

Any of:

string

string

>= 1 characters <= 80 characters

null

null

length

Any of:

string

string

>= 1 characters <= 80 characters

null

null

construction_details

Construction Details

Array<string>

<= 3 items

edge_or_border

Any of:

string

string

>= 1 characters <= 120 characters

null

null

hardware

Any of:

string

string

>= 1 characters <= 120 characters

null

null

finish

Any of:

string

string

>= 1 characters <= 120 characters

null

null

closure

Any of:

string

string

>= 1 characters <= 120 characters

null

null

notes

Any of:

string

string

>= 1 characters <= 280 characters

null

null

null

null

color

Any of:

string

string

null

null

material

Any of:

string

string

null

null

pattern

Any of:

string

string

null

null

fit

Any of:

string

string

Allowed values: slim regular loose

null

null

length

Any of:

string

string

null

null

metadata

Metadata

object

key

additional properties

any

pilot_brand

Any of:

string

string

null

null

Responses

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

string

null

null

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

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}