API Referenceviews

Create a hosted or embedded view

View as Markdown

Mint a scoped, component-gated hosted page or origin-restricted iframe composition. The response contains the bearer token once; keep it private.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Request

This endpoint expects an object.
scopeobjectRequired
componentsobjectOptional
Optional content and notification surfaces for the View.
controlbooleanOptionalDefaults to true
Allow live browser interaction and actions from the notification center.
expiresInSecondsintegerOptional<=2592000Defaults to 28800

View lifetime in seconds. Defaults to 8 hours; maximum 30 days.

presentationobjectOptional

Hosted presentation by default; use embedded with explicit allowed origins.

Response

Created
HostedViewCreateResponseobject
OR
EmbeddedViewCreateResponseobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error