Artwork

Create New Artwork

Create new artwork providing a product ID. The product ID can be found on the product page in the Roastify Merchant app. Fields is an array of field names from a previously designed product.

post/v1/artwork/new

Request

  • Base URL: https://api.roastify.app
  • URL: https://api.roastify.app/v1/artwork/new
  • Auth: API key in header x-api-key

Headers

Idempotency-Keystring

The idempotency key to use for the request (V4 UUID recommended)

Example:123e4567-e89b-12d3-a456-426614174000

Request body

productIdstring required

The ID of the product to update

Example request

{
  "productId": "cmb04pd9m4005k6049b3elq6d",
  "fields": [
    {
      "fieldId": "placeholder_title",
      "type": "text",
      "value": "Happy Birthday!"
    }
  ]
}

Response

Artwork generation job started successfully. Use the job ID to check the status of the job.

jobIdstring required

The job ID for tracking artwork generation progress

status'PENDING_VERSION' | 'WAITING_FOR_DEPLOY' | 'QUEUED' | 'EXECUTING' | 'REATTEMPTING' | 'FROZEN' | 'COMPLETED' | 'CANCELED' | 'FAILED' | 'CRASHED' | 'INTERRUPTED' | 'SYSTEM_FAILURE' | 'DELAYED' | 'EXPIRED' | 'TIMED_OUT' required

The current status of the artwork generation job

Example response

{
  "jobId": "run_01234567890abcdef",
  "status": "QUEUED"
}

Changes

No recorded changes to this operation across all 1 revision of this API.