Skip to main content
GET
/
ui
/
initSession
Init Session (Deprecated)
curl --request GET \
  --url https://partner.peaka.studio/api/v1/ui/initSession \
  --header 'Authorization: Bearer <token>'
{
  "sessionUrl": "https://partner.peaka.studio/api/v1/ui/session?code=2eccdbf31efa110943b470b9023e9a52587c166e4d1c21f23fabbcd7de5b74ab"
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Query Parameters

​
projectId
string
required

ID of the Project

​
timeoutInSeconds
integer<int32>

Session timeout in seconds

​
theme
string

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

​
themeOverride
boolean

Whether to override the default theme

Response

200 - */*

Session created successfully

​
sessionUrl
string

The URL of the Embedded Peaka session to be followed.

It is a one-time use URL that will redirect the user to the Peaka session.

​
partnerOrigin
string

The origin of the partner that the embedded studio is coming from.