Embedded Peaka Api

Init Session

Initializes an Embedded Peaka session and returns a session URL that can be used to embed the Peaka UI in an iframe.

Embedded Peaka allows you to integrate Peaka's data management capabilities — including connections, catalogs, caching, queries, and a full UI — directly into your application.

The returned <code>sessionUrl</code> should be loaded inside an iframe. For security, direct iframe embedding requires enabling "Embedded UI" in Developer Settings and registering your domain over HTTPS.

Configuration options

  • <code>theme</code> / <code>themeOverride</code>: Customize the look and feel of the embedded UI, including custom CSS theming.
  • <code>featureFlags</code>: Control visibility of UI sections (e.g., enable/disable queries, connectors).
  • <code>sessionMode</code>: Choose between <code>FULL_STUDIO</code> (complete Peaka experience) or <code>CONNECTOR_MODAL_ONLY</code> (streamlined connector setup).
  • <code>connectorType</code>: Pre-select a specific connector type when using connector-only mode.
  • <code>autoCreateCatalog</code>: Automatically create a catalog after a connection is established.

See also: Data Management Tool with UI

post/ui/initSession

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/ui/initSession
  • Auth: HTTP bearer

Request body

projectIdstring

The project ID.

themestring

The theme to be used.

sessionMode'CONNECTOR_MODAL_ONLY' | 'FULL_STUDIO'

The session mode, determining the type of session to be initialized.

themeOverrideboolean

Flag indicating whether the theme should be overridden.

timeoutInSecondsinteger

The timeout duration in seconds.

Response

Session created successfully

Changes

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