v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-10336.5 KB

sessions

Create a session

Creates a new partial-import session and mints the initial hydration token to pass to the widget. Requires your backend license key — never call this client-side.

post/auth/

Request body

import_identifierstring

A label for your own bookkeeping (e.g. schema name, import type). Not used for lookups. Defaults to "".

expires_ininteger

Hydration token TTL in seconds. Defaults to 21600 (6 hours).

Example request

{
  "import_identifier": "user_import_v1",
  "expires_in": 3600
}

Response

Session created

sessionIdstring uuid

Backend session identifier. Persist this durably — needed to resume the session or delete it later.

hydrationIdstring

Short-lived access token. Pass this to the widget to start or resume the session.

expiresIninteger

Seconds until the hydrationId expires.

savedAtstring date-time

Example response

{
  "sessionId": "1b6acf28-8748-4120-8d7a-4b7846d5e487",
  "hydrationId": "<signed-token>",
  "expiresIn": 21600,
  "savedAt": "2026-06-19T18:00:00.000Z"
}

All 3 operations