IMimentiv
Realtime Emotion API

Claim a queued realtime session

Changed on

Ask whether a queued session has been admitted yet, and start it if so. Also holds the caller's place in the queue.

post/v2/realtime/session/{session_id}/admission

Request

  • Base URL
    https://api.imentiv.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://api.imentiv.ai/oauth/authorize
      Token URL: https://api.imentiv.ai/oauth/token scopes: realtime.write

Path parameters

session_idstring required

The queued session ID to claim

Request body

audio_onlyboolean

Set true for a voice-only session: send no camera track on the WebRTC offer and expect no facial-emotion results. Any video track sent anyway is ignored. Defaults to false, a full video + audio session.

emotion_analysis_enabledboolean

Set false to run the session with no emotion analysis: no facial, vocal or text emotion model runs for it, and its results and windows carry no emotion values. Transcription is unaffected. It holds for the whole session, and a queued place keeps it however a later claim is sent. Defaults to true.

Response

A slot was free: the session exists and is ready for the WebRTC offer.

session_idstring required

Unique session identifier

statusstring required

Session status

messagestring required

Status message

webrtc_urlstring nullable

WebRTC connection URL for media streaming

ice_servers_ttlinteger nullable

Time-to-live for TURN credentials in seconds. Clients should refresh credentials before this expires for long-running sessions. None if TURN is disabled.

emotion_analysis_enabledboolean

Whether emotion analysis runs for this session. False when the session was started with emotion_analysis_enabled false. A caller that needs it off should check this before sending media.

Changes

  • bd825cd86e8cRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 72330e2229c7Revision changes
    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      the endpoint scheme security OAuth2Delegated was added to the API