API ReferenceQuote Week
Start a Quote Week run
Requires scope: `image_week:write` and a paid plan. Creates an `ImageWeekRun` and enqueues `ImageWeekRunJob`, which plans a week of AI quote-card images (Instagram/Pinterest) and generates them with a vision-verify retry loop. Subject to the plan's monthly quota (4 runs/month on Starter, 12 on Pro/Team) — `dry_run: true` requests are exempt.
Authorization
ApiKey AuthorizationBearer <token>
A personal API key created in the dashboard (Starter, Pro, and Team plans).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/image_week_runs" \ -H "Content-Type: application/json" \ -d '{ "topic": "resilience", "platform_config": { "instagram": { "social_account_id": 12 }, "pinterest": { "social_account_id": 14, "board_id": "board_123", "link": "https://example.com" } }, "cutoff_days": 7, "schedule_mode": "draft", "watermark_enabled": false, "dry_run": false }'{ "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" }}