Skip to main content
Changes to the public OpenAPI contract are listed by release or reference update date. See API versioning for the compatibility and deprecation policy.

Standard Webhooks headers only

Signed event deliveries and test pings use webhook-id, webhook-timestamp, and webhook-signature. If your receiver uses the previous X-UI-* signing headers, switch to a Standard Webhooks verifier.

Standard Webhooks signatures

Signed event deliveries and test pings include Standard Webhooks headers. At launch, deliveries also included the previous signing headers. See webhook authentication for library examples and how to use older signing secrets.

Account identity and workspace panel automation

Account identity supports the optional include_panel_automation query parameter. Eligible workspace integrations can opt in to automated panel launch with X-UI-Panel-Automation, a current quote, and an idempotency key. An active workspace spending cap applies. Account billing also includes the effective plan slug when available.

Live interviews and observer sessions

List live calls for a study and create or revoke short-lived observer links. Subscriptions can receive interview.started and interview.ended for live status updates.

Organization discovery and selection

Use List Organizations to discover accessible workspaces and send X-UI-Organization-ID to select one for a request. The public OpenAPI reference now lists GET /organizations in place of GET /admin/organizations.

Consolidated Intelligence Hub API

Use /intelligence-hub for sessions, sources, evidence, runs, chat, and deliverables. The OpenAPI reference consolidates the earlier /intelligence routes under this namespace.

Report exports and lifecycle events

Export editable report slides or generate private highlight clip exports. The webhook reference adds participant screening, start, and quality events, plus study pause, resume, stop, and quota events.

Private interview exports and asynchronous study planning

Create CSV or JSONL interview exports and poll for a private download. Queue study plan customization as a durable job and poll for the result. Interview reads accept redact_pii for common structured identifiers. The external panels API adds configuration and token management for external recruitment.