XreplyAIDevelopers
API ReferenceQuote Week

Get a Quote Week run

Requires scope: `image_week:read`. Poll for run progress. Returns the run plus its full item list.

GET
/image_week_runs/{id}
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 GET "https://example.com/image_week_runs/0"
{  "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"  },  "items": [    {      "id": 0,      "scheduled_post_id": 0,      "platform": "string",      "slot_at": "2019-08-24T14:15:22Z",      "item_type": "single_image",      "status": "pending",      "quote_text": "string",      "rendered_text": "string",      "style_key": "string",      "watermarked": true,      "attempts": 0,      "fail_reason": "garbled",      "image_r2_keys": [        "string"      ]    }  ]}