dives

Create a Dive embed session for a service account

Creates an embed session for the specified Dive using a service account. The username must be a service account username, not a user account.

post/v1/dives/{dive_id}/embed-session

Request

  • Base URL: https://api.motherduck.com
  • URL: https://api.motherduck.com/v1/dives/{dive_id}/embed-session
  • Auth: HTTP bearer

Path parameters

dive_idstring uuid required

Request body

usernamestring required

service account username within the organization to mint the embed session for

session_namestring

optional name used to reuse the same read-scaling session across embed requests

initial_stateobject

Seeds the embedded Dive's initial UI state. Each key is read by the corresponding useDiveState call inside the Dive.

versioninteger

optional Dive version to use for the embed session

Response

Successful response

sessionstring required

opaque dive embed session

Changes

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