ONIOKODeveloper
Sessions

Start a session for a subject with active perception consent.

In preparationNot released yet

This operation exists in the platform layer and is verified in CI, but it is not live for partners. The contract can still change before release. Do not build against it yet.

POST
/v1/sessions

Contains pseudonymous personal data. A repeated start with the same key returns the original result; an uncertain start is never repeated automatically.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Header Parameters

Idempotency-Key*Idempotency-Key
Match^[A-Za-z0-9._~-]+$
Length16 <= length <= 128

Request Body

application/json
  1. body
subject_id*Subject Id
Formatuuid
consent_id*Consent Id
Formatuuid
persona*Persona
Length1 <= length <= 100
language?Language
Default"en"
Value in"de""en""es"

Response Body

Successful response

application/json
  1. response
session_id*Session Id
Formatuuid
join_url*Join Url
Example Request
curl -X POST 'https://example.com/v1/sessions' \  -H 'Idempotency-Key: stringstringstri' \  -H 'Content-Type: application/json' \  -d '{  "subject_id": "80e197be-61ad-4068-b4ff-a483fb5c18f9",  "consent_id": "b6c6f30d-b96b-4de6-8a03-238cde9dddba",  "persona": "string"}'
Example Response
{  "session_id": "1ffd059c-17ea-40a8-8aef-70fd0307db82",  "join_url": "string"}

Read the registered state of a consented partner session. GET

The status describes the stored session record, not verified remote participant presence.

Read the latest perception for an active, consented session. GET

Contains pseudonymous personal data. A consent and session check occurs before and after reading.