custom-views-experimental

Get an embed token for a custom view

⚠️ Experimental — this endpoint may change or be removed without notice and is not subject to v2 backwards-compatibility guarantees. Do not build production-critical integrations against it yet.

Mints a short-lived, customer-scoped token for embedding a published custom view. Call this from your server with your API key, then pass the returned token to the embed SDK. Organization-scoped views cannot be embedded per-customer — this returns a 400 (ORG_SCOPED_VIEW_NOT_EMBEDDABLE) for one.

get/experimental/views/{displayId}/embed-token

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/experimental/views/{displayId}/embed-token
  • Auth: HTTP bearer

Path parameters

displayIdstring required

Query parameters

customerIdstring required

The customer to scope the view to: external id, Paid display id (cus_…), or internal id.

ttlSecondsinteger

Token lifetime in seconds (capped at 3600).

Response

200

tokenstring required

Short-lived signed token to pass to the embed SDK.

expiresAtstring date-time required

When the token expires (ISO 8601).

Changes

No recorded changes to this operation across all 1 revision of this API.