Jobs

Poll a job's status and result

Returns the job envelope. For completed jobs, all covers[].signedUrl values in result are freshly re-signed on every poll (1-hour expiry) and internal storage paths are stripped. Jobs belonging to a different API key/subscription return 404 job_not_found (not 403). A job with source: "web" ran in the web app: it returns its status and credits, and result is always null.

get/api/v1/jobs/{jobId}

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/jobs/{jobId}
  • Auth: HTTP bearer

Path parameters

jobIdstring uuid required

Job id returned by a job-creating endpoint (also embedded in poll_url).

Response

Current job state.

jobIdstring uuid required
status'queued' | 'processing' | 'completed' | 'failed' required
operation'generate' | 'variation' | 'edit_image' | 'upscale' | 'audiobook_cover' | 'remove_text' | 'generate_reference' | 'wrap' | 'wrap_extend_front' | 'generate_single' | 'edit_font' | 'convert_style' | 'layerize_text' | 'remove_text_variants' | 'audiobook_generate' | 'marketing_resource' | 'kit_regeneration' | 'brand_kit_extract' | 'series_next_book' | 'wrap_cover_generate' | 'wrap_cover_regenerate' | 'audiobook_upscale' | 'refine_cover' | 'wrap_back_cover_generate' | 'wrap_cover_export' required
source'api' | 'web' required

api: started through this API or the MCP server. web: recorded by the web app when a workspace member spent credits there; its output stays in the app.

external_refstring nullable required
credits_usedinteger nullable required

Credits actually consumed (set on completion; partial failures reduce it and refund the difference).

created_atstring date-time required
started_atstring date-time nullable required
completed_atstring date-time nullable required
errorstring nullable required

Failure message when status is failed (raw error_message string, not an error envelope).

Changes

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