/schemas/3.0.19/creative/preview-creative-request.json
Response Schema: /schemas/3.0.19/creative/preview-creative-response.json
Quick Start
Single Creative Preview
Direct HTML Embedding
For faster rendering without iframe overhead, request HTML directly:Batch Preview (Multiple Creatives)
Preview multiple creatives in one API call (5-10x faster):Variant Preview (Post-Flight)
Preview what a specific variant looked like when served. Usevariant_id from get_creative_delivery response:
get_creative_delivery includes its full manifest, you can also pass the manifest directly to preview_creative as a standard single request to re-render it.
Request Parameters
All modes use a single flat object withrequest_type as the discriminant.
Required column values: Single = required when
request_type is "single", Batch = required when "batch", Variant = required when "variant".
Input Sets
Generate multiple preview variants by providing different contexts:DEVICE_TYPE, COUNTRY, CITY, DMA, GDPR, US_PRIVACY, CONTENT_GENRE, etc.
Context descriptions: For AI-generated content like host-read audio ads.
Response Format
Single Mode Response
Batch Mode Response
Preview Structure
render_id and role.
Previewing generative creative
For generative formats — contextual display, AI-generated native, conversational ads — the creative doesn’t exist until serve time. Preview serves two distinct purposes:Pre-flight: representative samples
Before the campaign runs, use single or batch mode to preview what the agent could generate given different contexts. Passinputs with context_description to simulate serve-time conditions:
Post-flight: exact replay
After the campaign runs, use variant mode to see exactly what was served. Pass avariant_id from get_creative_delivery:
Setting expectations
For generative formats where every impression produces a different creative (like AI chat or real-time contextual), pre-flight previews are best understood as samples from a distribution rather than the ad. The brief and brand identity constrain the distribution; previews let you verify the agent interprets those constraints correctly.
Conversational and interactive formats
For formats where the ad is stateful — AI chat, interactive experiences, conversational native — preview takes on additional meaning:- Pre-flight renders a representative first interaction or simulated conversation. The
interactive_urlfield in the preview response (when present) provides a sandbox where reviewers can interact with the experience directly. Usecontext_descriptionto simulate different conversation entry points. - Post-flight variant replay shows the actual exchange that occurred. For multi-turn formats, the variant manifest captures the full content the agent produced (message sequence, responses, media assets shown). The level of detail depends on the agent — some provide full transcripts, others provide summarized content with anonymized user signals.
Quality mismatch
If the requested quality level is not supported, the agent renders at the best quality it can provide. The protocol does not require agents to support both levels — an agent that only generates at one fidelity ignores the parameter. There is no response field echoing back the actual quality used, so if quality accuracy matters for your workflow, verify by visual inspection or ask the agent about its capabilities throughlist_creative_formats.
Preview expiration and variant retention
All previews have anexpires_at timestamp. After expiration, preview URLs return errors and must be re-generated. For generative creative, re-generating a pre-flight preview may produce different output — the same brief and context can yield different creative each time.
Variant previews (post-flight) depend on the agent retaining variant data. Agents are not required to retain variant data indefinitely. If you request a variant preview for a variant the agent has purged, expect a standard error response. For long-running campaigns, retrieve and archive variant previews periodically rather than assuming they will remain available.
Examples
Device Variants
Batch with HTML Output
Preview multiple creatives for a grid layout:AI-Generated Audio Preview
HTTP Status Codes
Single mode:- 200 OK - Preview generated successfully
- 400 Bad Request - Invalid manifest or format_id
- 404 Not Found - Format not supported
- 200 OK - Batch processed (check individual
successfields) - 400 Bad Request - Invalid batch structure
Key Points
- Every render’s
preview_urlreturns an HTML page for iframe embedding - Use
output_format: "html"for grids of 10+ previews (no iframe overhead) - Batch mode is 5-10x faster than individual requests
- Preview URLs expire (check
expires_at) - Handle partial batch failures by checking each result’s
successfield
Related Documentation
- Advanced Preview Patterns - Caching, workflows, implementation notes
- Creative Manifests - Manifest structure
- Creative Formats - Format specifications