Live Avatar

List public avatars

get
/liveavatar/public-avatars/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

List of avatars

application/json
get
/liveavatar/public-avatars/
GET /api/v1/liveavatar/public-avatars/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of avatars

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
]

Get avatar by ID

get
/liveavatar/avatars/{id}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Avatar details

application/json
get
/liveavatar/avatars/{id}
GET /api/v1/liveavatar/avatars/{id} HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Avatar details

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

List contexts

get
/liveavatar/contexts/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

List of contexts

application/json
get
/liveavatar/contexts/
GET /api/v1/liveavatar/contexts/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of contexts

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
]

Get context by ID

get
/liveavatar/contexts/{id}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Context details

application/json
get
/liveavatar/contexts/{id}
GET /api/v1/liveavatar/contexts/{id} HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Context details

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

List voices

get
/liveavatar/voices/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200

List of voices

application/json
get
/liveavatar/voices/
GET /api/v1/liveavatar/voices/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

List of voices

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
]

Get voice by ID

get
/liveavatar/voices/{id}
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200

Voice details

application/json
get
/liveavatar/voices/{id}
GET /api/v1/liveavatar/voices/{id} HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Voice details

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Create avatar session token

post
/liveavatar/sessions/token/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
modestringRequired
avatar_idstringRequired
Responses
200

Session token created

No content
post
/liveavatar/sessions/token/
POST /api/v1/liveavatar/sessions/token/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "mode": "text",
  "avatar_id": "text",
  "avatar_persona": {
    "context_id": "text"
  }
}
200

Session token created

No content

Start avatar session

post
/liveavatar/sessions/start/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
session_tokenstringRequired
Responses
200

Session started

No content
post
/liveavatar/sessions/start/
POST /api/v1/liveavatar/sessions/start/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "session_token": "text"
}
200

Session started

No content

Stop avatar session

post
/liveavatar/sessions/stop/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
session_tokenstringRequired
Responses
200

Session stopped

No content
post
/liveavatar/sessions/stop/
POST /api/v1/liveavatar/sessions/stop/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "session_token": "text"
}
200

Session stopped

No content

Keep avatar session alive

post
/liveavatar/keep-alive-session/
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
session_tokenstringRequired
Responses
200

Session refreshed

No content
post
/liveavatar/keep-alive-session/
POST /api/v1/liveavatar/keep-alive-session/ HTTP/1.1
Host: api.therappai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "session_token": "text"
}
200

Session refreshed

No content
PreviousEmergency ContactsNextTasks

Last updated