Embedded Peaka Api

Init Session (Deprecated)

<strong>Deprecated.</strong> Use <code>POST /ui/initSession</code> instead, which supports feature flags, session modes, and additional configuration options.

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

get/ui/initSession

Request

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

Query parameters

projectIdstring required

ID of the Project

timeoutInSecondsinteger

Session timeout in seconds

themestring

Theme for the embedded UI (e.g., dark, light)

themeOverrideboolean

Whether to override the default theme

Response

Session created successfully

Changes

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