Skip to navigation
API ReferenceViews

Create a 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-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
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.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

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.
conversationSendbooleanOptional
Allow giving input to and cancelling Tasks in the included conversations. Defaults to the value of control.
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 headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

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