Artwork

Get Artwork Generation Status

Check the status of an artwork generation job using the job ID returned from the create endpoint.

get/v1/artwork/status/{jobId}

Request

  • Base URL: https://api.roastify.app
  • URL: https://api.roastify.app/v1/artwork/status/{jobId}
  • Auth: API key in header x-api-key

Path parameters

jobIdstring required

The job ID returned from the create artwork endpoint

Example:run_01234567890abcdef

Response

Artwork generation status retrieved successfully

jobIdstring required

The job ID

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 job

artworkUrlstring

The URL of the generated artwork (only present when status is COMPLETED). Must be HTTPS with valid image extension.

errorstring

Error message (only present when status is FAILED)

Example response

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

Changes

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