Create a Connect session Beta

Start the hosted page your user follows to pair a device and approve scopes

Beta. This endpoint is live for design partners, with keys that Dopl issues while the developer portal is being built.

POST /v1/connect_sessions

Creates the end user the first time it sees the external_user_id. The returned url opens the hosted page for 30 minutes; when the user finishes, the page redirects to redirect_uri with a public_token query parameter. Key scope connect.

Authorizations

Authorizationrequiredheaderstring

A project secret key, or a publishable pk_… key from your app, sent as Authorization: Bearer <key>. This is the only route a publishable key may call.

Idempotency-Keyheaderstring

Optional and accepted for consistency. This route does not replay responses.

Body

external_user_idrequiredstring

Your own ID for the end user.

allowed_kindsstring[]

Limit the devices offered, for example glasses. Defaults to every kind.

requested_scopesrequiredstring[]

Capability IDs or whole families such as present.*. At least one.

redirect_uristring

An http or https URL the page returns to with the public_token.

brandingConnectBranding

display_name, logo_url and accent_color (#RRGGBB), over your project's saved branding.

StatusBody
201ConnectSessionCreateResponse
400, 401, 403, 429Error