BEbey-dev
Speech-to-Video Sessions

Create Speech-to-Video Session

Changed on

Create a speech-to-video session.

Tip: do not use this directly, use the LiveKit plugin instead. See https://docs.livekit.io/agents/integrations/avatar/bey.

post/v1/sessions

Request

  • Base URL
    https://api.bey.dev
  • URL
    https://api.bey.dev/v1/sessions
  • Auth
    API key in header x-api-key

Request body

OR

Example request

{
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "url": "wss://<your-domain>.livekit.cloud",
  "token": "<your-livekit-token>"
}

Response

Created Speech-to-Video Session with ID

OR

Example response

{
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "avatar_id": "01234567-89ab-cdef-0123-456789abcdef",
  "status": {
    "started_at": "2022-01-01T00:00:00Z"
  },
  "url": "wss://<your-domain>.livekit.cloud"
}

Changes