XreplyAIDevelopers
API ReferenceQuote Week

List Quote Week runs

Requires scope: `image_week:read`. Returns the 20 most recent Quote Week runs for the authenticated user, ordered by `created_at` descending.

GET
/image_week_runs

Authorization

ApiKey
AuthorizationBearer <token>

A personal API key created in the dashboard (Starter, Pro, and Team plans).

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/image_week_runs"
{  "image_week_runs": [    {      "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 the current subscription and quota GET

Requires scope: `billing:read`. Read-only. Billing mutations (subscribe, cancel, change plan) are dashboard-only.

Start a Quote Week run POST

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.