Skip to main content
POST
/
v1
/
artwork
/
new
Create New Artwork
curl --request POST \
  --url https://api.roastify.app/v1/artwork/new \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "productId": "cmb04pd9m4005k6049b3elq6d",
  "fields": [
    {
      "fieldId": "placeholder_title",
      "type": "text",
      "value": "Happy Birthday!"
    }
  ]
}'
{
  "jobId": "run_01234567890abcdef",
  "status": "QUEUED"
}

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests provided by Roastify. A Base or Pro plan is required to use the API.

Headers

​
Idempotency-Key
string

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

Example:

"123e4567-e89b-12d3-a456-426614174000"

Body

application/json
​
productId
string
required

The ID of the product to update

Example:

"cmb04pd9m4005k6049b3elq6d"

​
fields
object[]
required

Response

Artwork generation job started successfully

​
jobId
string
required

The job ID for tracking artwork generation progress

Example:

"run_01234567890abcdef"

​
status
enum<string>
required

The current status of the artwork generation job

Available options:
PENDING_VERSION,
WAITING_FOR_DEPLOY,
QUEUED,
EXECUTING,
REATTEMPTING,
FROZEN,
COMPLETED,
CANCELED,
FAILED,
CRASHED,
INTERRUPTED,
SYSTEM_FAILURE,
DELAYED,
EXPIRED,
TIMED_OUT
Example:

"QUEUED"

⌘I