API ReferenceQuote Week
Cancel a Quote Week run
Requires scope: `image_week:write`. Cancels a run that hasn't reached a terminal status yet. No-op if the run is already `completed`, `failed`, or `canceled`.
Authorization
ApiKey AuthorizationBearer <token>
A personal API key created in the dashboard (Starter, Pro, and Team plans).
In: header
Path Parameters
id*integer
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/image_week_runs/0/cancel"{ "image_week_run": { "id": 0, "status": "pending", "content_plan_id": 0, "schedule_mode": "draft", "topic": "string", "pack": "string", "platform_config": {}, "cutoff_days": 0, "watermark_enabled": true, "watermark_text": "string", "watermark_every_n": 0, "dry_run": true, "template_version": "string", "total_items": 0, "completed_items": 0, "failed_items": 0, "shortfall_reason": "quota", "error_message": "string", "images_generated": 0, "retry_count": 0, "garble_count": 0, "est_cost_cents": 0, "duration_ms": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}Get a Quote Week run GET
Requires scope: `image_week:read`. Poll for run progress. Returns the run plus its full item list.
Regenerate a failed Quote Week item POST
Requires scope: `image_week:write`. Reprocesses a single `failed` item — resets its attempt count and re-enqueues generation → verify → post-build → slot-fill for that item alone. Only `failed` items can be regenerated (422 `INVALID_STATE` otherwise).