Skip to content
Figur

Dispatch a background-swap (with image) workflow

POST
/v1/background-swap-with-image
 
curl --request POST \
  --url https://example.com/v1/background-swap-with-image \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "source_image_s3_key": "example", "source_render_public_id": "example", "background_image_public_id": "example", "output_preset": "example", "pilot_brand": "example" }'

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
BackgroundSwapWithImageRequest

POST /v1/background-swap-with-image — swap to a catalog background.

object
source_image_s3_key
Any of:
string
source_render_public_id
Any of:
string
background_image_public_id
required
Background Image Public Id
string
output_preset
required
Output Preset
string
pilot_brand
Any of:
string
Example generated
{
  "source_image_s3_key": "example",
  "source_render_public_id": "example",
  "background_image_public_id": "example",
  "output_preset": "example",
  "pilot_brand": "example"
}

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