Skip to main content
POST
Preview a creative in an exact placement context

Authorizations

Authorization
string
header
required

API key or access token

Path Parameters

creativeId
string
required

Immutable review reference returned by the queue. Preview requires the exact review:<id> namespace; bare creative ids are not accepted.

Pattern: ^review:[1-9]\d*$
Example:

"review:42"

Body

application/json

Requests an authority-resolved preview for one immutable creative review placement context.

context_ref
string<uuid>
required

Opaque preview context returned on this exact review. The server resolves all route, provider, capability, package, and placement identity.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
expected_content_digest
string
required

SHA-256 content digest from the exact review version being previewed.

Pattern: ^[a-f0-9]{64}$
expected_review_version_digest
string

Versioned review identity from this exact review row. Legacy callers may omit it; the server then derives the current identity from the persisted review context. A supplied value must match, and the request is rejected if the version changes before or after provider dispatch.

Pattern: ^[a-f0-9]{64}$

Response

Preview a creative in an exact placement context

Authority-resolved preview result. Provider payloads remain inert data only: clients must never mount, prefetch, or execute provider content. A separate external-view envelope may only be opened after a second explicit user gesture through the MCP host bridge.

status
enum<string>
required
Available options:
completed,
source_only
contextRef
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
authority
object
required
preview
object
required
sourceTrust
object | null
required
representativeSellerPreview
object
externalOpen
object