Skip to main content
GET
/
v1
/
artwork
/
status
/
{jobId}
Get Artwork Generation Status
curl --request GET \
  --url https://api.roastify.app/v1/artwork/status/{jobId} \
  --header 'x-api-key: <api-key>'
{
  "jobId": "run_01234567890abcdef",
  "status": "COMPLETED",
  "artworkUrl": "https://roastify-artwork.s3.us-east-1.amazonaws.com/outreach/01_artwork/1716537600000.jpeg",
  "error": "Failed to generate artwork"
}

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.

Path Parameters

​
jobId
string
required

The job ID returned from the create artwork endpoint

Example:

"run_01234567890abcdef"

Response

Artwork generation status retrieved successfully

​
jobId
string
required

The job ID

Example:

"run_01234567890abcdef"

​
status
enum<string>
required

The current status of the job

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

"COMPLETED"

​
artworkUrl
string

The URL of the generated artwork (only present when status is COMPLETED)

Example:

"https://roastify-artwork.s3.us-east-1.amazonaws.com/outreach/01_artwork/1716537600000.jpeg"

​
error
string

Error message (only present when status is FAILED)

Example:

"Failed to generate artwork"