Dispatch an extract-trial-items workflow

POST

/v1/extract

curl --request POST \
  --url https://example.com/v1/extract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "trial_image": "example", "runtime_config": {}, "extraction_context": { "max_items": 1, "product_name": "example", "product_description": "example" } }'

Authorizations

• sk_*

Parameters

Header Parameters

X-Shopify-Hmac-Sha256

Any of:

string

string

null

null

Request Body ^required

Media type application/json

ExtractTrialItemsRequest

Extraction submission.

object

trial_image

required

Trial Image

S3 object key of the model / trial image to extract items from.

string

runtime_config

Any of:

object

object

key

additional properties

any

null

null

extraction_context

Any of:

ExtractionContext

ExtractionContext

Caller hints to target the on-sale item. Mirrors studio.schema.extraction.ExtractionContext.

object

max_items

Any of:

integer

integer

>= 1

null

null

product_name

Any of:

string

string

null

null

product_description

Any of:

string

string

null

null

null

null

Example ^generated

{
  "trial_image": "example",
  "runtime_config": {},
  "extraction_context": {
    "max_items": 1,
    "product_name": "example",
    "product_description": "example"
  }
}

Responses

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

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 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

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