iAdvizeDocs

Generate starter questions

Asks for starter questions from up to 50 read pages, with the dashboard's guards: only read product and category pages are eligible, a page needs a language the site serves, and the site's daily budget caps how many pages are generated. The questions are written switched off, so a person reviews them before they reach shoppers. Pages that are not accepted are listed with their reason. The answer is `202` when at least one page was accepted: read the outcome from the page and from `GET /sites/{siteId}/pages/{pageId}/generations`. It is `200` when none was. When every page was skipped because the daily budget is used, the answer is `429` with the code `generation_limit_reached` and a `Retry-After` that gives the seconds until the budget resets at the next UTC midnight.

POST
/api/v1/sites/{siteId}/pages/generate

Authorization

ApiKeyAuth
AuthorizationBearer <token>

A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).

In: header

Path Parameters

siteId*string

The site id (prefixed site_). A site id that isn't yours is a 404, same as any other cross-tenant id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/v1/sites/string/pages/generate" \  -H "Content-Type: application/json" \  -d '{    "pageIds": [      "spg_01kvnwmagvf27rc9cze5rm9e1r"    ],    "replace": true  }'
{  "data": {    "accepted": [      "string"    ],    "skipped": [      {        "pageId": "string",        "reason": "string"      }    ],    "started": true,    "replace": true,    "budget": {      "limit": 0,      "used": 0,      "remaining": 0,      "resetsAt": "2019-08-24T14:15:22Z"    }  }}