Create a new session

POST 
/api/v1/session/start

Creates a new session based on the input request data

Request

application/json

Body

required

oneOf

MOD1

history

object[]

Array [

content stringrequired

import_id stringnullablerequired

role stringrequired

Possible values: [assistant, system, user]

]

time_limit_s numbernullable

voice_override stringnullable

llm stringnullable

webhook stringnullable

persona stringnullable

MOD2

time_limit_s numbernullable

voice_override stringnullable

llm stringnullable

webhook stringnullable

scenario string

persona string

Responses

200

Session created successfully

application/json

Schema

Schema

session

object

required

created_at date-timerequired

ended_at date-time

id stringrequired

livekit_room stringrequired

metadata required

persona stringnullablerequired

project stringrequired

scenario stringnullablerequired

llm stringnullable

state SessionState (string)required

Possible values: [ended, in_progress, not_started]

voice_override stringnullable

time_limit_s numbernullablerequired

persona

object

created_at date-timerequired

description stringrequired

id stringrequired

image_url stringnullablerequired

name stringrequired

project stringrequired

tags

object[]

required

Array [

human_name stringrequired

name stringrequired

]

voice

object

required

embeddings number[]required

id stringrequired

language stringrequired

model stringrequired

name stringrequired

preview_url stringnullablerequired

project stringrequired

service stringrequired

voice stringrequired

scenario

object

created_at date-timerequired

id stringrequired

name stringrequired

project stringrequired

prompt stringrequired

connection_details

object

required

token string

url string

Example (from schema)

{
  "session": {
    "created_at": "2024-07-29T15:51:28.071Z",
    "ended_at": "2024-07-29T15:51:28.071Z",
    "id": "string",
    "livekit_room": "string",
    "metadata": {},
    "persona": "string",
    "project": "string",
    "scenario": "string",
    "llm": "string",
    "state": "ended",
    "voice_override": "string",
    "time_limit_s": 0
  },
  "persona": {
    "created_at": "2024-07-29T15:51:28.071Z",
    "description": "string",
    "id": "string",
    "image_url": "string",
    "name": "string",
    "project": "string",
    "tags": [
      {
        "human_name": "string",
        "name": "string"
      }
    ],
    "voice": {
      "embeddings": [
        0
      ],
      "id": "string",
      "language": "string",
      "model": "string",
      "name": "string",
      "preview_url": "string",
      "project": "string",
      "service": "string",
      "voice": "string"
    }
  },
  "scenario": {
    "created_at": "2024-07-29T15:51:28.071Z",
    "id": "string",
    "name": "string",
    "project": "string",
    "prompt": "string"
  },
  "connection_details": {
    "token": "string",
    "url": "string"
  }
}

400

Invalid request data

500

Internal server error

Loading...