v1

latestOpenAPI 3.1.02026-07-263370112.1 KB
axp-render

Bulk Render Optimized Pages

Queue render jobs for a list of paths on a registered AXP site. Each path is fetched, sanitized, and persisted as an AXP optimized page asynchronously, so the endpoint returns immediately with one job entry per input path.

Paths are normalized (trimmed and given a leading slash) and deduplicated before queueing. A path that already has an in-flight job on the same site coalesces onto that job, so the same batch can be retried safely. Inputs are capped at 100 paths per call.

post/orchestration/render-bulk/{brand_id}/sites/{site_id}

Path parameters

brand_idinteger required

The unique identifier for the brand that owns the site.

The unique identifier for the brand that owns the site.

site_idstring required

The ULID of the registered AXP site to render pages on.

The ULID of the registered AXP site to render pages on.

Request body

pathsstring[] required

Paths on the site to render. Each entry is trimmed and given a leading slash if missing. Duplicates are removed; in-flight jobs for the same path are reused.

Response

One item per unique path with the queued job id and current status.

pathstring required

The normalized path that was queued, echoed back from the request.

job_idinteger required

The render job identifier. Use it when correlating with logs or webhooks.

status'pending' | 'running' | 'succeeded' | 'failed' | 'cancelled' required

Status of the job at response time. pending means a fresh job was queued; running means the call coalesced onto an in-flight job for the same path.