{ "openapi": "3.1.0", "info": { "title": "Live avatar API", "version": "0.1.0" }, "servers": [ { "url": "https://api.liveavatar.com" } ], "paths": { "/v1/sessions/token": { "post": { "tags": [ "Sessions" ], "summary": "Create Session Token", "description": "Create session token for an API-key-authenticated user.\n\nMinting a session token is only doable via an API key (``APIUserDep``) \u2014 a\nsession JWT (``SessionUser``) cannot mint a token for another participant.", "operationId": "create_session_token_v1_sessions_token_post", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/FullSDKSessionTokenConfigDataSchema" }, { "$ref": "#/components/schemas/LiteSDKSessionTokenConfigDataSchema" } ], "title": "Payload" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_SDKSessionTokenSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] } ] } }, "/v1/sessions/start": { "post": { "tags": [ "Sessions" ], "summary": "Start Session", "description": "Start a new session", "operationId": "start_session_v1_sessions_start_post", "responses": { "201": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_StartSessionResponseSchema_" } } } } }, "security": [ { "HTTPBearer": [] } ] } }, "/v1/sessions/stop": { "post": { "tags": [ "Sessions" ], "summary": "Stop Session", "description": "Stop a session", "operationId": "stop_session_v1_sessions_stop_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopSessionSchema", "default": { "reason": "USER_CLOSED" } } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] }, { "HTTPBearer": [] } ] } }, "/v1/sessions/keep-alive": { "post": { "tags": [ "Sessions" ], "summary": "Keep Session Alive", "description": "Keep the session alive", "operationId": "keep_session_alive_v1_sessions_keep_alive_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepSessionAliveSchema", "default": {} } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "APIKeyHeader": [] }, { "HTTPBearer": [] } ] } }, "/v1/sessions": { "get": { "tags": [ "Sessions" ], "summary": "List Sessions", "description": "List active sessions for the authenticated user", "operationId": "list_sessions_v1_sessions_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "type", "in": "query", "required": true, "schema": { "enum": [ "active", "historic" ], "type": "string", "title": "Type" } }, { "name": "avatar_id", "in": "query", "required": false, "schema": { "title": "Avatar Id", "type": "string" } }, { "name": "embed_id", "in": "query", "required": false, "schema": { "title": "Embed Id", "type": "string" } }, { "name": "context_id", "in": "query", "required": false, "schema": { "title": "Context Id", "type": "string" } }, { "name": "api_key_id", "in": "query", "required": false, "schema": { "title": "Api Key Id", "type": "string" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_PaginatedResponse_Union_ListSessionEntrySchema__ListHistoricEntrySchema___" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}": { "get": { "tags": [ "Sessions" ], "summary": "Get Session", "description": "Get a specific session by ID", "operationId": "get_session_v1_sessions__session_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_Union_ListSessionEntrySchema__ListHistoricEntrySchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/transcript": { "get": { "tags": [ "Sessions" ], "summary": "Get Session Transcript", "description": "Get the transcript for a session", "operationId": "get_session_transcript_v1_sessions__session_id__transcript_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "start_timestamp", "in": "query", "required": false, "schema": { "title": "Start Timestamp", "type": "integer" } }, { "name": "end_timestamp", "in": "query", "required": false, "schema": { "title": "End Timestamp", "type": "integer" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_SessionTranscriptResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/sessions/{session_id}/events": { "delete": { "tags": [ "Sessions" ], "summary": "Delete Session Events", "description": "Hard delete all session events for a given session", "operationId": "delete_session_events_v1_sessions__session_id__events_delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "session_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Session Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/avatars": { "get": { "tags": [ "Avatar" ], "summary": "List User Avatars", "description": "Get avatars list for auth user", "operationId": "list_user_avatars_v1_avatars_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_PaginatedResponse_AvatarSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/avatars/public": { "get": { "tags": [ "Avatar" ], "summary": "List Public Avatars", "description": "Get public avatars list", "operationId": "list_public_avatars_v1_avatars_public_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_PaginatedResponse_AvatarSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/avatars/{avatar_id}": { "get": { "tags": [ "Avatar" ], "summary": "Get Avatar By Id", "description": "Get avatar by id", "operationId": "get_avatar_by_id_v1_avatars__avatar_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "avatar_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Avatar Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_AvatarSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Avatar" ], "summary": "Update Avatar", "description": "Update avatar", "operationId": "update_avatar_v1_avatars__avatar_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "avatar_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Avatar Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAvatarSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_AvatarSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Avatar" ], "summary": "Delete Avatar", "description": "Soft delete avatar", "operationId": "delete_avatar_v1_avatars__avatar_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "avatar_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Avatar Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voice_agents": { "get": { "tags": [ "Voice Agents" ], "summary": "List Voice Agents", "description": "List voice agents.\n\n`scope` selects which agents are returned:\n* `private` (default) \u2014 only the agents your space owns.\n* `public` \u2014 preset agents owned by no space. Read-only: they cannot be updated\n or deleted (PATCH/DELETE return `404`).\n\nItems omit `agent_configuration` \u2014 retrieve a single agent to see its full configuration.", "operationId": "list_voice_agents_v1_voice_agents_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "scope", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/VoiceAgentScopeEnum", "default": "private" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_list_VoiceAgentListItemSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voice_agents/{agent_id}": { "get": { "tags": [ "Voice Agents" ], "summary": "Get Voice Agent", "description": "Retrieve a voice agent, including its full `agent_configuration`.", "operationId": "get_voice_agent_v1_voice_agents__agent_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_VoiceAgentResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Voice Agents" ], "summary": "Delete Voice Agent", "description": "Delete a voice agent.\n\nFails with `409` while any embed still references the agent; the referencing embed ids are\nreturned in the response payload. Repoint or delete those embeds first, then retry.", "operationId": "delete_voice_agent_v1_voice_agents__agent_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "agent_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Agent Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voices": { "get": { "tags": [ "Voices" ], "summary": "List Voices", "description": "Get voices list", "operationId": "list_voices_v1_voices_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "voice_type", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/VoiceListTypeEnum", "default": "public" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_PaginatedResponse_VoiceSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voices/third_party": { "post": { "tags": [ "Voices" ], "summary": "Bind Third Party Voice", "description": "Bind a third-party voice (e.g. ElevenLabs) using a stored secret.\n\nValidates the secret can be used to bind a third-party voice\nand creates a voice record.\nReturns a voice_id usable in sessions.", "operationId": "bind_third_party_voice_v1_voices_third_party_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyVoiceBindRequestSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_ThirdPartyVoiceBindResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voices/{voice_id}": { "get": { "tags": [ "Voices" ], "summary": "Get Voice By Id", "description": "Get voice by id", "operationId": "get_voice_by_id_v1_voices__voice_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_VoiceSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Voices" ], "summary": "Update Voice", "description": "Update voice", "operationId": "update_voice_v1_voices__voice_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoiceSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_VoiceSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Voices" ], "summary": "Delete Voice", "description": "Delete voice by id", "operationId": "delete_voice_v1_voices__voice_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/voices/{voice_id}/preview": { "get": { "tags": [ "Voices" ], "summary": "Get Voice Preview By Id", "description": "Get voice preview by id", "operationId": "get_voice_preview_by_id_v1_voices__voice_id__preview_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "voice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Voice Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_VoicePreviewResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/contexts": { "post": { "tags": [ "Contexts" ], "summary": "Create Context", "description": "Create a new user context record", "operationId": "create_context_v1_contexts_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContextSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_ContextDetailSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Contexts" ], "summary": "List User Contexts", "description": "List user contexts", "operationId": "list_user_contexts_v1_contexts_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_PaginatedResponse_ContextSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/contexts/{context_id}": { "get": { "tags": [ "Contexts" ], "summary": "Get Context By Id", "description": "Get a user context by id", "operationId": "get_context_by_id_v1_contexts__context_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_ContextDetailSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "Contexts" ], "summary": "Update Context", "description": "Update a user context", "operationId": "update_context_v1_contexts__context_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContextSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_ContextDetailSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Contexts" ], "summary": "Delete Context", "description": "Delete a user context", "operationId": "delete_context_v1_contexts__context_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/contexts/{context_id}/copy": { "post": { "tags": [ "Contexts" ], "summary": "Copy Context", "description": "Hard-copy a readable context into the caller's space as a new PRIVATE context.\n\nOptional `name` overrides the copy's name; otherwise it defaults to\n\"{original name} (Copy)\".", "operationId": "copy_context_v1_contexts__context_id__copy_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "context_id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "title": "Context Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/CopyContextSchema" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_ContextDetailSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/memory": { "post": { "tags": [ "Memory" ], "summary": "Create Memory", "operationId": "create_memory_v1_memory_post", "security": [ { "APIKeyHeader": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSessionMemory" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_MemoryResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Memory" ], "summary": "List Memories", "operationId": "list_memories_v1_memory_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/MemoryTypeEnum" }, { "type": "null" } ], "title": "Type" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 20, "title": "Page Size" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_PaginatedResponse_MemoryListItemResponse__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/memory/{memory_id}": { "get": { "tags": [ "Memory" ], "summary": "Get Memory", "operationId": "get_memory_v1_memory__memory_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "memory_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Memory Id" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_MemoryWithEpisodesResponse_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "Memory" ], "summary": "Delete Memory", "operationId": "delete_memory_v1_memory__memory_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "memory_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Memory Id" } } ], "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/secrets": { "post": { "tags": [ "Secrets" ], "summary": "Create Secret", "description": "Create a new encrypted secret for the authenticated user's space.\n\nThis endpoint:\n- Requires API key authentication\n- Encrypts the secret value using AWS KMS\n- Stores the encrypted value in the database\n- Returns metadata about the created secret (including id for future reference)\n\nArgs:\n service: Injected secrets service\n payload: Request containing secret_name and secret_value\n\nReturns:\n Response with created secret metadata including id\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space\n 500 Internal Server Error: If encryption or storage fails", "operationId": "create_secret_v1_secrets_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSecretRequestSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreateSecretResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Secrets" ], "summary": "List Secrets", "description": "List all secrets for the authenticated user's space.\n\nThis endpoint:\n- Requires API key authentication\n- Returns metadata only (id, name, type) - never returns decrypted values\n- Results are ordered by creation date (newest first)\n\nArgs:\n service: Injected secrets service\n\nReturns:\n Response with list of secret metadata\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space", "operationId": "list_secrets_v1_secrets_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_list_SecretListItemSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/secrets/{secret_id}": { "delete": { "tags": [ "Secrets" ], "summary": "Delete Secret", "description": "Delete a secret by id.\n\nThis endpoint:\n- Requires API key authentication\n- Permanently deletes the encrypted secret from the database\n\nArgs:\n service: Injected secrets service\n secret_id: The id of the secret to delete\n\nReturns:\n Response confirming deletion\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space\n 404 Not Found: If the secret doesn't exist", "operationId": "delete_secret_v1_secrets__secret_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "secret_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Secret Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/llm-configurations": { "post": { "tags": [ "LLM Configurations" ], "summary": "Create Llm Configuration", "description": "Create a new LLM configuration for the authenticated user's space.\n\nThis endpoint:\n- Requires API key or session authentication\n- Validates that the secret_id belongs to the user's space\n- Creates a new LLM configuration with the provided settings\n\nArgs:\n service: Injected LLM configuration service\n payload: Request containing url, display_name, model_name, and secret_id\n\nReturns:\n Response with created LLM configuration\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space or secret is invalid", "operationId": "create_llm_configuration_v1_llm_configurations_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLLMConfigurationSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_LLMConfigurationResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "LLM Configurations" ], "summary": "List Llm Configurations", "description": "List all LLM configurations for the authenticated user's space.\n\nThis endpoint:\n- Requires API key or session authentication\n- Returns all LLM configurations for the user's space\n- Results are ordered by creation date (newest first)\n\nArgs:\n service: Injected LLM configuration service\n\nReturns:\n Response with list of LLM configurations\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space", "operationId": "list_llm_configurations_v1_llm_configurations_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_list_LLMConfigurationListItemSchema__" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/llm-configurations/{config_id}": { "get": { "tags": [ "LLM Configurations" ], "summary": "Get Llm Configuration", "description": "Get an LLM configuration by ID.\n\nThis endpoint:\n- Requires API key or session authentication\n- Returns the full LLM configuration details\n\nArgs:\n service: Injected LLM configuration service\n config_id: The ID of the LLM configuration to retrieve\n\nReturns:\n Response with the LLM configuration\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space\n 404 Not Found: If the configuration doesn't exist", "operationId": "get_llm_configuration_v1_llm_configurations__config_id__get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_LLMConfigurationResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "patch": { "tags": [ "LLM Configurations" ], "summary": "Update Llm Configuration", "description": "Update an LLM configuration by ID.\n\nThis endpoint:\n- Requires API key or session authentication\n- Validates that the new secret_id (if provided) belongs to the user's space\n- Updates only the provided fields\n\nArgs:\n service: Injected LLM configuration service\n config_id: The ID of the LLM configuration to update\n payload: Request containing fields to update\n\nReturns:\n Response with the updated LLM configuration\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space or secret is invalid\n 404 Not Found: If the configuration doesn't exist", "operationId": "update_llm_configuration_v1_llm_configurations__config_id__patch", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLLMConfigurationSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_LLMConfigurationResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "LLM Configurations" ], "summary": "Delete Llm Configuration", "description": "Delete an LLM configuration by ID.\n\nThis endpoint:\n- Requires API key or session authentication\n- Permanently deletes the LLM configuration\n\nArgs:\n service: Injected LLM configuration service\n config_id: The ID of the LLM configuration to delete\n\nReturns:\n Response confirming deletion\n\nRaises:\n 400 Bad Request: If user doesn't have an associated space\n 404 Not Found: If the configuration doesn't exist", "operationId": "delete_llm_configuration_v1_llm_configurations__config_id__delete", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "config_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Config Id" } }, { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_NoneType_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/llm-models": { "get": { "tags": [ "LLM Models" ], "summary": "List Llm Models", "description": "List the managed LLM models selectable per provider.\n\nThese are the `llm_settings` choices accepted on a `liveavatar_agent`'s\nconfiguration and on a session's `avatar_persona` \u2014 a static catalog, not\nspace-scoped data. Custom LLM endpoints (`/v1/llm-configurations`) are a\nseparate concept and are not listed here.", "operationId": "list_llm_models_v1_llm_models_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_dict_LLMProviderEnum__list_str___" } } } } } } }, "/v1/languages": { "get": { "tags": [ "Languages" ], "summary": "Get Languages", "description": "Return the list of supported languages with code and display name.", "operationId": "get_languages_v1_languages_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_list_LanguageSchema__" } } } } } } }, "/v1/users/credits": { "get": { "tags": [ "Users" ], "summary": "Get User Credits", "description": "Get the current user's credit balance.", "operationId": "get_user_credits_v1_users_credits_get", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_UserCreditsSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v2/embeddings": { "post": { "tags": [ "Embeddings" ], "summary": "Create Embed V2", "description": "Create an embed avatar with sandbox support.", "operationId": "create_embed_v2_v2_embeddings_post", "security": [ { "APIKeyHeader": [] } ], "parameters": [ { "name": "la_session", "in": "cookie", "required": false, "schema": { "title": "La Session", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEmbedV2RequestSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response_CreateEmbedV2ResponseSchema_" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } } }, "components": { "schemas": { "AgoraConfigSchema": { "properties": { "agora_app_id": { "type": "string", "title": "Agora App Id" }, "agora_token": { "type": "string", "title": "Agora Token" }, "agora_channel": { "type": "string", "title": "Agora Channel" }, "agora_uid": { "type": "string", "title": "Agora Uid" } }, "type": "object", "required": [ "agora_app_id", "agora_token", "agora_channel", "agora_uid" ], "title": "AgoraConfigSchema" }, "AvatarPersonaSchema": { "properties": { "voice_id": { "title": "Voice Id", "description": "Voice ID. If empty use default avatar voice", "type": "string", "format": "uuid" }, "context_id": { "title": "Context Id", "description": "Context ID", "type": "string", "format": "uuid" }, "language": { "type": "string", "title": "Language", "description": "Language", "default": "en" }, "voice_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/ElevenLabsVoiceSettings" }, { "$ref": "#/components/schemas/FishAudioVoiceSettings" }, { "$ref": "#/components/schemas/CartesiaVoiceSettings" } ], "discriminator": { "propertyName": "provider", "mapping": { "cartesia": "#/components/schemas/CartesiaVoiceSettings", "elevenLabs": "#/components/schemas/ElevenLabsVoiceSettings", "fish": "#/components/schemas/FishAudioVoiceSettings" } } }, { "type": "null" } ], "title": "Voice Settings", "description": "Additional voice settings (provider-specific, discriminated by 'provider' field)" }, "stt_config": { "anyOf": [ { "$ref": "#/components/schemas/STTConfigSchema-Input" }, { "type": "null" } ], "description": "ASR/STT configuration override" }, "llm_settings": { "anyOf": [ { "$ref": "#/components/schemas/OpenAILLMSetting" }, { "type": "null" } ], "description": "LLM selection (provider + model). None \u2192 the managed default model." } }, "type": "object", "title": "AvatarPersonaSchema" }, "AvatarSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "space_id": { "title": "Space Id", "type": "string" }, "type": { "$ref": "#/components/schemas/AvatarTypeEnum", "default": "VIDEO" }, "status": { "$ref": "#/components/schemas/AvatarStatusEnum", "default": "INIT" }, "name": { "type": "string", "title": "Name" }, "preview_url": { "title": "Preview Url", "type": "string" }, "is_expired": { "type": "boolean", "title": "Is Expired", "default": false }, "default_voice": { "anyOf": [ { "$ref": "#/components/schemas/DefaultAvatarVoice" }, { "type": "null" } ] }, "default_voice_agent_id": { "title": "Default Voice Agent Id", "type": "string" }, "is_1080p": { "type": "boolean", "title": "Is 1080P", "default": false }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "error_message": { "title": "Error Message", "description": "Error message if training failed (prefer detailed, fallback to short).", "readOnly": true, "type": "string" } }, "type": "object", "required": [ "id", "name", "created_at", "updated_at", "error_message" ], "title": "AvatarSchema" }, "AvatarStatusEnum": { "type": "string", "enum": [ "ACTIVE", "INIT", "DEPLOYING", "FAILED" ], "title": "AvatarStatusEnum" }, "AvatarTypeEnum": { "type": "string", "enum": [ "IMAGE", "VIDEO" ], "title": "AvatarTypeEnum" }, "CartesiaAgentConfigSchema-Input": { "properties": { "secret_id": { "type": "string", "format": "uuid", "title": "Secret Id", "description": "Secret ID for CARTESIA_API_KEY" }, "agent_id": { "type": "string", "title": "Agent Id", "description": "Cartesia Agent ID" } }, "type": "object", "required": [ "secret_id", "agent_id" ], "title": "CartesiaAgentConfigSchema", "description": "Config for Cartesia Agent mode in LITE sessions. All fields required when present.\n\nMirrors `ElevenLabsAgentConfigSchema` (field names align with the stored\nvoice_agents `CartesiaAgentConfigSchema`) so the routing path maps one onto the\nother without renaming. Cartesia agents own their voice/prompt server-side, so \u2014\nunlike ElevenLabs \u2014 there is no voice_id override or dynamic_variables here." }, "CartesiaAgentConfigSchema-Output": { "properties": { "agent_type": { "type": "string", "const": "cartesia_agent", "title": "Agent Type", "default": "cartesia_agent" }, "mode": { "$ref": "#/components/schemas/SessionModeEnum", "default": "LITE" }, "agent_id": { "type": "string", "minLength": 1, "title": "Agent Id", "description": "Cartesia Agent ID" }, "secret_id": { "type": "string", "format": "uuid", "title": "Secret Id", "description": "Secret ID referencing a CARTESIA_API_KEY secret" } }, "additionalProperties": false, "type": "object", "required": [ "agent_id", "secret_id" ], "title": "CartesiaAgentConfigSchema", "description": "`agent_configuration` shape for the `cartesia` agent type.\n\nReferences a Cartesia-hosted agent by id plus a stored secret; the secret is held\nby reference only (`secret_id` \u2192 `space_secrets`), never inline. Mirrors\n`ElevenLabsAgentConfigSchema` exactly \u2014 field names align with the LITE-session\n`CartesiaAgentConfigSchema` (`src/sessions/session_token_schema.py`) so the\nsession-start path can map one onto the other without renaming.\n\n`extra=\"forbid\"` rejects unknown keys (and any liveavatar_agent fields sent\nagainst the wrong type) at write time." }, "CartesiaModelEnum": { "type": "string", "enum": [ "sonic-3.5", "sonic-3", "sonic-2", "sonic-turbo" ], "title": "CartesiaModelEnum" }, "CartesiaVoiceSettings": { "properties": { "provider": { "type": "string", "const": "cartesia", "title": "Provider", "default": "cartesia" }, "speed": { "type": "number", "maximum": 1.5, "minimum": 0.6, "title": "Speed", "default": 1.0 }, "model": { "$ref": "#/components/schemas/CartesiaModelEnum", "description": "Cartesia TTS model.", "default": "sonic-3.5" } }, "type": "object", "title": "CartesiaVoiceSettings", "description": "Cartesia-specific voice settings for TTS configuration." }, "ContextDetailSchema": { "properties": { "name": { "type": "string", "maxLength": 64, "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "opening_text": { "title": "Opening Text", "type": "string" }, "id": { "type": "string", "format": "uuid", "title": "Id" }, "links": { "title": "Links", "items": { "$ref": "#/components/schemas/ContextLinkSchema" }, "type": "array" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "required_dynamic_variables": { "items": { "type": "string" }, "type": "array", "title": "Required Dynamic Variables", "readOnly": true } }, "type": "object", "required": [ "name", "prompt", "opening_text", "id", "created_at", "updated_at", "required_dynamic_variables" ], "title": "ContextDetailSchema" }, "ContextLinkSchema": { "properties": { "url": { "type": "string", "title": "Url" }, "faq": { "title": "Faq", "type": "string" }, "id": { "type": "string", "format": "uuid", "title": "Id" } }, "type": "object", "required": [ "url", "faq", "id" ], "title": "ContextLinkSchema" }, "ContextSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "created_at", "updated_at" ], "title": "ContextSchema" }, "CopyContextSchema": { "properties": { "name": { "title": "Name", "type": "string", "maxLength": 64 } }, "type": "object", "title": "CopyContextSchema" }, "CreateContextSchema": { "properties": { "name": { "type": "string", "maxLength": 64, "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "opening_text": { "title": "Opening Text", "type": "string" }, "links": { "title": "Links", "items": { "$ref": "#/components/schemas/CreateUpdateContextLinkSchema" }, "type": "array" } }, "type": "object", "required": [ "name", "prompt", "opening_text" ], "title": "CreateContextSchema" }, "CreateEmbedV2RequestSchema": { "properties": { "avatar_id": { "type": "string", "format": "uuid", "title": "Avatar Id" }, "context_id": { "title": "Context Id", "type": "string", "format": "uuid" }, "voice_id": { "title": "Voice Id", "type": "string", "format": "uuid" }, "voice_agent_id": { "title": "Voice Agent Id", "description": "Resolve voice / context from a stored voice_agent (the new primitive). Mutually exclusive with voice_id / context_id.", "type": "string", "format": "uuid" }, "type": { "$ref": "#/components/schemas/EmbedAvatarTypeEnum", "default": "DEFAULT" }, "max_session_duration": { "title": "Max Session Duration", "description": "Max session duration in seconds", "type": "integer", "exclusiveMinimum": 0.0 }, "default_language": { "title": "Default Language", "description": "Default language code (e.g. 'en', 'es', 'multi')", "type": "string", "maxLength": 5 }, "is_sandbox": { "type": "boolean", "title": "Is Sandbox", "description": "Whether to enable sandbox mode for sessions", "default": false }, "orientation": { "$ref": "#/components/schemas/EmbedOrientation", "description": "Embed orientation: horizontal (16:9) or vertical (9:16)", "default": "horizontal" } }, "type": "object", "required": [ "avatar_id" ], "title": "CreateEmbedV2RequestSchema" }, "CreateEmbedV2ResponseSchema": { "properties": { "embed_id": { "type": "string", "format": "uuid", "title": "Embed Id" }, "url": { "type": "string", "title": "Url" }, "script": { "title": "Script", "type": "string" }, "orientation": { "$ref": "#/components/schemas/EmbedOrientation", "default": "horizontal" } }, "type": "object", "required": [ "embed_id", "url" ], "title": "CreateEmbedV2ResponseSchema" }, "CreateLLMConfigurationSchema": { "properties": { "base_url": { "title": "Base Url", "description": "The LLM API endpoint URL", "type": "string" }, "display_name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Display Name", "description": "Display name for the configuration" }, "model_name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Model Name", "description": "The model name to use" }, "secret_id": { "type": "string", "maxLength": 36, "minLength": 1, "title": "Secret Id", "description": "ID of the secret containing the API key" } }, "type": "object", "required": [ "display_name", "model_name", "secret_id" ], "title": "CreateLLMConfigurationSchema", "description": "Request schema for creating a new LLM configuration" }, "CreateSecretRequestSchema": { "properties": { "secret_name": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Secret Name", "description": "Name of the secret" }, "secret_value": { "type": "string", "minLength": 1, "title": "Secret Value", "description": "The secret value to encrypt and store" }, "secret_type": { "$ref": "#/components/schemas/SecretTypeEnum", "description": "The type of secret" } }, "type": "object", "required": [ "secret_name", "secret_value", "secret_type" ], "title": "CreateSecretRequestSchema", "description": "Request schema for creating a new secret" }, "CreateSecretResponseSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "secret_name": { "type": "string", "title": "Secret Name" } }, "type": "object", "required": [ "id", "secret_name" ], "title": "CreateSecretResponseSchema", "description": "Response schema after creating a secret" }, "CreateSessionMemory": { "properties": { "memory_type": { "$ref": "#/components/schemas/MemoryTypeEnum" }, "session_id": { "type": "string", "format": "uuid", "title": "Session Id" } }, "type": "object", "required": [ "memory_type", "session_id" ], "title": "CreateSessionMemory" }, "CreateUpdateContextLinkSchema": { "properties": { "url": { "type": "string", "title": "Url" }, "faq": { "title": "Faq", "type": "string" }, "id": { "title": "Id", "type": "string", "format": "uuid" } }, "type": "object", "required": [ "url", "faq" ], "title": "CreateUpdateContextLinkSchema" }, "DefaultAvatarVoice": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" } }, "type": "object", "required": [ "id", "name" ], "title": "DefaultAvatarVoice" }, "DemoLLMConfig": { "properties": { "provider": { "type": "string", "title": "Provider", "description": "Provider tag, informational (e.g. 'anthropic', 'openai')" }, "model": { "type": "string", "title": "Model", "description": "Model name passed to the provider SDK" }, "base_url": { "title": "Base Url", "description": "Custom API base URL", "type": "string" }, "ciphertext_api_key": { "title": "Ciphertext Api Key", "description": "Base64-encoded encrypted API key (same scheme as voice.encrypted_api_key)", "type": "string" } }, "type": "object", "required": [ "provider", "model" ], "title": "DemoLLMConfig", "description": "Inline LLM keys for the demo session path.\n\nStashed on `demo_avatars.meta[\"llm\"]` so demo rows don't FK into the\nuser-owned `llm_configurations` table. The agent runtime consumes\n`model`, `base_url`, and `ciphertext_api_key` directly via `LLMConfig`." }, "ElevenLabsAgentConfigSchema-Input": { "properties": { "secret_id": { "type": "string", "format": "uuid", "title": "Secret Id", "description": "Secret ID for ELEVENLABS_API_KEY" }, "agent_id": { "type": "string", "title": "Agent Id", "description": "ElevenLabs Agent ID" }, "voice_id": { "title": "Voice Id", "description": "Optional ElevenLabs voice ID override. When set, sent to the ElevenLabs Agent WebSocket as `conversation_config_override.tts.voice_id`, overriding the agent's default voice for this session. When omitted, the agent's configured default voice is used. See https://elevenlabs.io/docs/eleven-agents/api-reference/eleven-agents/websocket", "type": "string" }, "dynamic_variables": { "title": "Dynamic Variables", "description": "ElevenLabs Agent dynamic variables injected into prompts and tools. See https://elevenlabs.io/docs/eleven-agents/customization/personalization/dynamic-variables", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "object" } }, "type": "object", "required": [ "secret_id", "agent_id" ], "title": "ElevenLabsAgentConfigSchema", "description": "Config for ElevenLabs Agent mode in LITE sessions. All fields required when present." }, "ElevenLabsAgentConfigSchema-Output": { "properties": { "agent_type": { "type": "string", "const": "elevenlabs_agent", "title": "Agent Type", "default": "elevenlabs_agent" }, "mode": { "$ref": "#/components/schemas/SessionModeEnum", "default": "LITE" }, "agent_id": { "type": "string", "minLength": 1, "title": "Agent Id", "description": "ElevenLabs Agent ID" }, "secret_id": { "type": "string", "format": "uuid", "title": "Secret Id", "description": "Secret ID referencing an ELEVENLABS_API_KEY secret" } }, "additionalProperties": false, "type": "object", "required": [ "agent_id", "secret_id" ], "title": "ElevenLabsAgentConfigSchema", "description": "`agent_configuration` for an `elevenlabs_agent`.\n\nThe conversation is handled by an agent you host on ElevenLabs, referenced by its\n`agent_id` plus one of your stored secrets holding an ElevenLabs API key. The key\nis held by reference only and is never returned. Unknown fields are rejected\nrather than silently ignored, including fields that belong to a\n`liveavatar_agent` configuration." }, "ElevenLabsModelEnum": { "type": "string", "enum": [ "eleven_flash_v2_5", "eleven_multilingual_v2" ], "title": "ElevenLabsModelEnum" }, "ElevenLabsVoiceSettings": { "properties": { "provider": { "type": "string", "const": "elevenLabs", "title": "Provider", "default": "elevenLabs" }, "speed": { "type": "number", "maximum": 1.2, "minimum": 0.8, "title": "Speed", "default": 1.0 }, "stability": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Stability", "default": 0.75 }, "similarity_boost": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Similarity Boost", "default": 0.75 }, "style": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Style", "default": 0.0 }, "use_speaker_boost": { "type": "boolean", "title": "Use Speaker Boost", "default": true }, "model": { "$ref": "#/components/schemas/ElevenLabsModelEnum", "description": "ElevenLabs TTS model. Options: 'eleven_flash_v2_5' (default, faster) or 'eleven_multilingual_v2' (better quality).", "default": "eleven_flash_v2_5" }, "apply_language_text_normalization": { "type": "boolean", "title": "Apply Language Text Normalization", "description": "Apply ElevenLabs language-specific text normalization. Improves pronunciation for languages with complex orthography \u2014 currently only Japanese ('ja') is supported. Enabling this adds latency, so it is opt-in and only valid when the session language is set to 'ja'.", "default": false } }, "type": "object", "title": "ElevenLabsVoiceSettings", "description": "ElevenLabs-specific voice settings for TTS configuration." }, "EmbedAvatarTypeEnum": { "type": "string", "enum": [ "DEFAULT", "WIDGET" ], "title": "EmbedAvatarTypeEnum" }, "EmbedOrientation": { "type": "string", "enum": [ "horizontal", "vertical" ], "title": "EmbedOrientation" }, "FishAudioModelEnum": { "type": "string", "enum": [ "s1", "s2" ], "title": "FishAudioModelEnum" }, "FishAudioVoiceSettings": { "properties": { "provider": { "type": "string", "const": "fish", "title": "Provider", "default": "fish" }, "speed": { "type": "number", "maximum": 1.2, "minimum": 0.8, "title": "Speed", "default": 1.0 }, "model": { "$ref": "#/components/schemas/FishAudioModelEnum", "description": "Fish Audio TTS model.", "default": "s2" }, "latency_mode": { "type": "string", "enum": [ "normal", "balanced" ], "title": "Latency Mode", "description": "Latency mode: 'normal' (~500ms) or 'balanced' (~300ms).", "default": "balanced" } }, "type": "object", "title": "FishAudioVoiceSettings", "description": "Fish Audio-specific voice settings for TTS configuration." }, "FullAgentConfigSchema": { "properties": { "agent_type": { "type": "string", "const": "liveavatar_agent", "title": "Agent Type", "default": "liveavatar_agent" }, "mode": { "$ref": "#/components/schemas/SessionModeEnum", "default": "FULL" }, "voice_id": { "type": "string", "format": "uuid", "title": "Voice Id", "description": "Voice used by the pipeline TTS stage" }, "context_id": { "title": "Context Id", "description": "Context ID", "type": "string", "format": "uuid" }, "language": { "type": "string", "title": "Language", "description": "Language", "default": "en" }, "voice_settings": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/ElevenLabsVoiceSettings" }, { "$ref": "#/components/schemas/FishAudioVoiceSettings" }, { "$ref": "#/components/schemas/CartesiaVoiceSettings" } ], "discriminator": { "propertyName": "provider", "mapping": { "cartesia": "#/components/schemas/CartesiaVoiceSettings", "elevenLabs": "#/components/schemas/ElevenLabsVoiceSettings", "fish": "#/components/schemas/FishAudioVoiceSettings" } } }, { "type": "null" } ], "title": "Voice Settings", "description": "Additional voice settings (provider-specific, discriminated by 'provider' field)" }, "stt_config": { "anyOf": [ { "$ref": "#/components/schemas/STTConfigSchema-Output" }, { "type": "null" } ], "description": "ASR/STT configuration override" }, "llm_settings": { "anyOf": [ { "$ref": "#/components/schemas/OpenAILLMSetting" }, { "type": "null" } ], "description": "LLM selection (provider + model). Omitted on legacy agents \u2192 the managed default model." } }, "additionalProperties": false, "type": "object", "required": [ "voice_id" ], "title": "FullAgentConfigSchema", "description": "`agent_configuration` for a `liveavatar_agent`.\n\nThe conversation runs on the managed speech-to-text => LLM => text-to-speech\npipeline, using the voice, context, and language selected here. Unknown fields\nare rejected rather than silently ignored, and the language must be supported by\nthe chosen speech-to-text provider and text-to-speech model." }, "FullSDKSessionTokenConfigDataSchema": { "properties": { "mode": { "type": "string", "const": "FULL", "title": "Mode", "default": "FULL" }, "avatar_id": { "type": "string", "format": "uuid", "title": "Avatar Id" }, "is_sandbox": { "type": "boolean", "title": "Is Sandbox", "default": false }, "video_settings": { "anyOf": [ { "$ref": "#/components/schemas/VideoSettings" }, { "type": "null" } ], "description": "Video encoding settings" }, "max_session_duration": { "title": "Max Session Duration", "description": "Maximum session duration in seconds. Must be <= the configured limit for your subscription tier.", "type": "integer" }, "avatar_persona": { "anyOf": [ { "$ref": "#/components/schemas/AvatarPersonaSchema" }, { "type": "null" } ], "description": "Inline voice / context / voice_settings. Mutually exclusive with voice_agent.", "deprecated": true }, "voice_agent": { "anyOf": [ { "$ref": "#/components/schemas/VoiceAgentRef" }, { "type": "null" } ], "description": "Reference a stored voice_agent by id; the server resolves its agent_type and builds the session accordingly (which per-session overrides apply depends on the type \u2014 see VoiceAgentRef). An elevenlabs_agent produces a LITE session even on this FULL request. Mutually exclusive with avatar_persona." }, "interactivity_type": { "$ref": "#/components/schemas/SessionInteractivityTypeEnum", "default": "CONVERSATIONAL" }, "llm_configuration_id": { "title": "Llm Configuration Id", "description": "Optional custom LLM configuration ID", "type": "string", "format": "uuid" }, "dynamic_variables": { "title": "Dynamic Variables", "description": "Values for ${var} placeholders in the context's opening_text and prompt. Required keys are derived from the context; extra keys are ignored. At most 50 entries; keys <= 64 chars; values <= 1000 chars.", "additionalProperties": { "type": "string" }, "type": "object" }, "memory": { "anyOf": [ { "$ref": "#/components/schemas/MemoryRef" }, { "type": "null" } ], "description": "Attach session memory. Provide `prev_session_id` to seed/reuse from a prior session, `session_memory_id` to attach an existing memory, or both (must resolve to the same memory_id)." } }, "type": "object", "required": [ "avatar_id" ], "title": "Full Mode" }, "GeminiRealtimeConfigSchema": { "properties": { "secret_id": { "type": "string", "format": "uuid", "title": "Secret Id", "description": "Secret ID referencing GEMINI_API_KEY secret" }, "context_id": { "title": "Context Id", "description": "Context ID.", "type": "string", "format": "uuid" }, "voice": { "$ref": "#/components/schemas/GeminiRealtimeVoiceEnum", "description": "Gemini Realtime voice", "default": "Puck" }, "temperature": { "type": "number", "maximum": 2.0, "minimum": 0.0, "title": "Temperature", "description": "Sampling temperature", "default": 0.8 }, "model": { "$ref": "#/components/schemas/GeminiRealtimeModelEnum", "description": "Gemini Realtime model", "default": "gemini-3.1-flash-live-preview" } }, "type": "object", "required": [ "secret_id" ], "title": "GeminiRealtimeConfigSchema", "description": "Config for Gemini Realtime Agent mode in LITE sessions." }, "GeminiRealtimeModelEnum": { "type": "string", "enum": [ "gemini-2.5-flash-native-audio-preview-12-2025", "gemini-3.1-flash-live-preview" ], "title": "GeminiRealtimeModelEnum" }, "GeminiRealtimeVoiceEnum": { "type": "string", "enum": [ "Achernar", "Achird", "Algenib", "Algieba", "Alnilam", "Aoede", "Autonoe", "Callirrhoe", "Charon", "Despina", "Enceladus", "Erinome", "Fenrir", "Gacrux", "Iapetus", "Kore", "Laomedeia", "Leda", "Orus", "Pulcherrima", "Puck", "Rasalgethi", "Sadachbia", "Sadaltager", "Schedar", "Sulafat", "Umbriel", "Vindemiatrix", "Zephyr", "Zubenelgenubi" ], "title": "GeminiRealtimeVoiceEnum" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "KeepSessionAliveSchema": { "properties": { "session_id": { "title": "Session Id", "type": "string", "format": "uuid" } }, "type": "object", "title": "KeepSessionAliveSchema" }, "LLMConfigurationListItemSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "display_name": { "type": "string", "title": "Display Name" }, "model_name": { "type": "string", "title": "Model Name" }, "secret_id": { "type": "string", "title": "Secret Id" } }, "type": "object", "required": [ "id", "display_name", "model_name", "secret_id" ], "title": "LLMConfigurationListItemSchema", "description": "Schema for an LLM configuration item in list response" }, "LLMConfigurationResponseSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "base_url": { "title": "Base Url", "type": "string" }, "display_name": { "type": "string", "title": "Display Name" }, "model_name": { "type": "string", "title": "Model Name" }, "secret_id": { "type": "string", "title": "Secret Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "base_url", "display_name", "model_name", "secret_id", "created_at", "updated_at" ], "title": "LLMConfigurationResponseSchema", "description": "Response schema for an LLM configuration" }, "LLMProviderEnum": { "type": "string", "enum": [ "openai" ], "title": "LLMProviderEnum" }, "LanguageSchema": { "properties": { "language": { "type": "string", "title": "Language", "description": "Display name of the language" }, "code": { "type": "string", "title": "Code", "description": "ISO language code" } }, "type": "object", "required": [ "language", "code" ], "title": "LanguageSchema", "description": "Schema for a supported language with code and display name." }, "ListHistoricEntrySchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "duration": { "type": "integer", "title": "Duration" }, "source": { "$ref": "#/components/schemas/SessionSourceEnum" }, "mode": { "$ref": "#/components/schemas/SessionModeEnum" }, "is_sandbox": { "type": "boolean", "title": "Is Sandbox" }, "api_key_id": { "title": "Api Key Id", "description": "API key that created the session, if any", "type": "string" }, "credits_consumed": { "type": "number", "title": "Credits Consumed", "description": "Total credits consumed by this session" }, "end_at": { "title": "End At", "type": "string", "format": "date-time" }, "end_reason": { "anyOf": [ { "$ref": "#/components/schemas/SessionEndReasonEnum" }, { "type": "null" } ] } }, "type": "object", "required": [ "id", "created_at", "updated_at", "duration", "source", "mode", "is_sandbox", "credits_consumed" ], "title": "ListHistoricEntrySchema" }, "ListSessionEntrySchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "duration": { "type": "integer", "title": "Duration" }, "source": { "$ref": "#/components/schemas/SessionSourceEnum" }, "mode": { "$ref": "#/components/schemas/SessionModeEnum" }, "is_sandbox": { "type": "boolean", "title": "Is Sandbox" }, "api_key_id": { "title": "Api Key Id", "description": "API key that created the session, if any", "type": "string" }, "credits_consumed": { "type": "number", "title": "Credits Consumed", "description": "Total credits consumed by this session" } }, "type": "object", "required": [ "id", "created_at", "updated_at", "duration", "source", "mode", "is_sandbox", "credits_consumed" ], "title": "ListSessionEntrySchema" }, "LiteSDKSessionTokenConfigDataSchema": { "properties": { "mode": { "type": "string", "const": "LITE", "title": "Mode", "default": "LITE" }, "avatar_id": { "type": "string", "format": "uuid", "title": "Avatar Id" }, "is_sandbox": { "type": "boolean", "title": "Is Sandbox", "default": false }, "video_settings": { "anyOf": [ { "$ref": "#/components/schemas/VideoSettings" }, { "type": "null" } ], "description": "Video encoding settings" }, "max_session_duration": { "title": "Max Session Duration", "description": "Maximum session duration in seconds. Must be <= the configured limit for your subscription tier.", "type": "integer" }, "livekit_config": { "anyOf": [ { "$ref": "#/components/schemas/LiveKitConfigSchema" }, { "type": "null" } ], "description": "LiveKit config. Allow users to override the livekit config" }, "agora_config": { "anyOf": [ { "$ref": "#/components/schemas/AgoraConfigSchema" }, { "type": "null" } ], "description": "Agora config. Allow users to use Agora as the transport layer" }, "elevenlabs_agent_config": { "anyOf": [ { "$ref": "#/components/schemas/ElevenLabsAgentConfigSchema-Input" }, { "type": "null" } ], "description": "ElevenLabs Agent config. When set, uses ElevenLabs Agent instead of default." }, "cartesia_agent_config": { "anyOf": [ { "$ref": "#/components/schemas/CartesiaAgentConfigSchema-Input" }, { "type": "null" } ], "description": "Cartesia Agent config. When set, uses Cartesia Agent instead of default." }, "openai_realtime_config": { "anyOf": [ { "$ref": "#/components/schemas/OpenAIRealtimeConfigSchema" }, { "type": "null" } ], "description": "OpenAI Realtime config. When set, uses OpenAI Realtime API instead of default." }, "gemini_realtime_config": { "anyOf": [ { "$ref": "#/components/schemas/GeminiRealtimeConfigSchema" }, { "type": "null" } ], "description": "Gemini Realtime config. When set, uses Gemini Live API instead of default." } }, "type": "object", "required": [ "avatar_id" ], "title": "Lite Mode" }, "LiveKitConfigSchema": { "properties": { "livekit_url": { "type": "string", "title": "Livekit Url" }, "livekit_room": { "type": "string", "title": "Livekit Room" }, "livekit_client_token": { "type": "string", "title": "Livekit Client Token" } }, "type": "object", "required": [ "livekit_url", "livekit_room", "livekit_client_token" ], "title": "LiveKitConfigSchema" }, "MemoryEpisodeSchema": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "sequence_num": { "type": "integer", "title": "Sequence Num" }, "summary": { "type": "string", "title": "Summary" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "session_id", "sequence_num", "summary", "created_at" ], "title": "MemoryEpisodeSchema" }, "MemoryListItemResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "memory_type": { "$ref": "#/components/schemas/MemoryTypeEnum" }, "memory_content_preview": { "title": "Memory Content Preview", "type": "string" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "memory_type", "memory_content_preview", "created_at", "updated_at" ], "title": "MemoryListItemResponse" }, "MemoryRef": { "properties": { "prev_session_id": { "title": "Prev Session Id", "description": "Seed memory from a prior FULL-mode session. Reused if a session-memory already exists for that session; otherwise sync-bootstrapped.", "type": "string", "format": "uuid" }, "session_memory_id": { "title": "Session Memory Id", "description": "Attach an existing session-typed memory by id (must belong to caller's space).", "type": "string", "format": "uuid" } }, "type": "object", "title": "MemoryRef", "description": "Session-memory attach request.\n\nEither field may be set. If both are set, they must resolve to the same\nmemory_id; mismatch -> 400." }, "MemoryResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "memory_type": { "$ref": "#/components/schemas/MemoryTypeEnum" }, "memory_content": { "title": "Memory Content", "type": "string" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "id", "memory_type", "memory_content", "created_at" ], "title": "MemoryResponse" }, "MemoryTypeEnum": { "type": "string", "enum": [ "session" ], "title": "MemoryTypeEnum" }, "MemoryWithEpisodesResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "memory_type": { "$ref": "#/components/schemas/MemoryTypeEnum" }, "memory_content": { "title": "Memory Content", "type": "string" }, "session_episodes": { "items": { "$ref": "#/components/schemas/MemoryEpisodeSchema" }, "type": "array", "title": "Session Episodes" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "memory_type", "memory_content", "session_episodes", "created_at", "updated_at" ], "title": "MemoryWithEpisodesResponse" }, "OpenAILLMSetting": { "properties": { "provider": { "type": "string", "const": "openai", "title": "Provider", "default": "openai" }, "model": { "$ref": "#/components/schemas/OpenAIModelEnum", "default": "gpt-4o-mini" } }, "type": "object", "title": "OpenAILLMSetting" }, "OpenAIModelEnum": { "type": "string", "enum": [ "gpt-4o", "gpt-4o-mini", "gpt-5-nano", "gpt-5.4-nano" ], "title": "OpenAIModelEnum", "description": "Recommended OpenAI chat models selectable for the FULL pipeline (LA-1498)." }, "OpenAIRealtimeConfigSchema": { "properties": { "secret_id": { "type": "string", "format": "uuid", "title": "Secret Id", "description": "Secret ID referencing OPENAI_API_KEY secret" }, "context_id": { "title": "Context Id", "description": "Context ID.", "type": "string", "format": "uuid" }, "voice": { "$ref": "#/components/schemas/OpenAIRealtimeVoiceEnum", "description": "OpenAI Realtime voice", "default": "alloy" }, "temperature": { "type": "number", "maximum": 1.2, "minimum": 0.6, "title": "Temperature", "description": "Sampling temperature", "default": 0.8 }, "model": { "type": "string", "title": "Model", "description": "OpenAI Realtime model", "default": "gpt-realtime" } }, "type": "object", "required": [ "secret_id" ], "title": "OpenAIRealtimeConfigSchema", "description": "Config for OpenAI Realtime Agent mode in LITE sessions." }, "OpenAIRealtimeVoiceEnum": { "type": "string", "enum": [ "alloy", "ash", "ballad", "coral", "echo", "fable", "onyx", "nova", "shimmer", "sage", "verse", "marin", "cedar" ], "title": "OpenAIRealtimeVoiceEnum" }, "PaginatedResponse_AvatarSchema_": { "properties": { "count": { "type": "integer", "title": "Count" }, "next": { "title": "Next", "type": "string" }, "previous": { "title": "Previous", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/AvatarSchema" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "count", "results" ], "title": "PaginatedResponse[AvatarSchema]" }, "PaginatedResponse_ContextSchema_": { "properties": { "count": { "type": "integer", "title": "Count" }, "next": { "title": "Next", "type": "string" }, "previous": { "title": "Previous", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/ContextSchema" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "count", "results" ], "title": "PaginatedResponse[ContextSchema]" }, "PaginatedResponse_MemoryListItemResponse_": { "properties": { "count": { "type": "integer", "title": "Count" }, "next": { "title": "Next", "type": "string" }, "previous": { "title": "Previous", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/MemoryListItemResponse" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "count", "results" ], "title": "PaginatedResponse[MemoryListItemResponse]" }, "PaginatedResponse_Union_ListSessionEntrySchema__ListHistoricEntrySchema__": { "properties": { "count": { "type": "integer", "title": "Count" }, "next": { "title": "Next", "type": "string" }, "previous": { "title": "Previous", "type": "string" }, "results": { "items": { "anyOf": [ { "$ref": "#/components/schemas/ListSessionEntrySchema" }, { "$ref": "#/components/schemas/ListHistoricEntrySchema" } ] }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "count", "results" ], "title": "PaginatedResponse[Union[ListSessionEntrySchema, ListHistoricEntrySchema]]" }, "PaginatedResponse_VoiceSchema_": { "properties": { "count": { "type": "integer", "title": "Count" }, "next": { "title": "Next", "type": "string" }, "previous": { "title": "Previous", "type": "string" }, "results": { "items": { "$ref": "#/components/schemas/VoiceSchema" }, "type": "array", "title": "Results" } }, "type": "object", "required": [ "count", "results" ], "title": "PaginatedResponse[VoiceSchema]" }, "Response_AvatarSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/AvatarSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[AvatarSchema]" }, "Response_ContextDetailSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ContextDetailSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[ContextDetailSchema]" }, "Response_CreateEmbedV2ResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/CreateEmbedV2ResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[CreateEmbedV2ResponseSchema]" }, "Response_CreateSecretResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/CreateSecretResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[CreateSecretResponseSchema]" }, "Response_LLMConfigurationResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/LLMConfigurationResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[LLMConfigurationResponseSchema]" }, "Response_MemoryResponse_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/MemoryResponse" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[MemoryResponse]" }, "Response_MemoryWithEpisodesResponse_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/MemoryWithEpisodesResponse" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[MemoryWithEpisodesResponse]" }, "Response_NoneType_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "type": "null", "title": "Data" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[NoneType]" }, "Response_PaginatedResponse_AvatarSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginatedResponse_AvatarSchema_" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[PaginatedResponse[AvatarSchema]]" }, "Response_PaginatedResponse_ContextSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginatedResponse_ContextSchema_" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[PaginatedResponse[ContextSchema]]" }, "Response_PaginatedResponse_MemoryListItemResponse__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginatedResponse_MemoryListItemResponse_" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[PaginatedResponse[MemoryListItemResponse]]" }, "Response_PaginatedResponse_Union_ListSessionEntrySchema__ListHistoricEntrySchema___": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginatedResponse_Union_ListSessionEntrySchema__ListHistoricEntrySchema__" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[PaginatedResponse[Union[ListSessionEntrySchema, ListHistoricEntrySchema]]]" }, "Response_PaginatedResponse_VoiceSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/PaginatedResponse_VoiceSchema_" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[PaginatedResponse[VoiceSchema]]" }, "Response_SDKSessionTokenSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SDKSessionTokenSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[SDKSessionTokenSchema]" }, "Response_SessionTranscriptResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/SessionTranscriptResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[SessionTranscriptResponseSchema]" }, "Response_StartSessionResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/StartSessionResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[StartSessionResponseSchema]" }, "Response_ThirdPartyVoiceBindResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ThirdPartyVoiceBindResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[ThirdPartyVoiceBindResponseSchema]" }, "Response_Union_ListSessionEntrySchema__ListHistoricEntrySchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/ListSessionEntrySchema" }, { "$ref": "#/components/schemas/ListHistoricEntrySchema" }, { "type": "null" } ], "title": "Data" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[Union[ListSessionEntrySchema, ListHistoricEntrySchema]]" }, "Response_UserCreditsSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/UserCreditsSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[UserCreditsSchema]" }, "Response_VoiceAgentResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/VoiceAgentResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[VoiceAgentResponseSchema]" }, "Response_VoicePreviewResponseSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/VoicePreviewResponseSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[VoicePreviewResponseSchema]" }, "Response_VoiceSchema_": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "anyOf": [ { "$ref": "#/components/schemas/VoiceSchema" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[VoiceSchema]" }, "Response_dict_LLMProviderEnum__list_str___": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "title": "Data", "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/LLMProviderEnum" }, "type": "object" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[dict[LLMProviderEnum, list[str]]]" }, "Response_list_LLMConfigurationListItemSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "title": "Data", "items": { "$ref": "#/components/schemas/LLMConfigurationListItemSchema" }, "type": "array" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[list[LLMConfigurationListItemSchema]]" }, "Response_list_LanguageSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "title": "Data", "items": { "$ref": "#/components/schemas/LanguageSchema" }, "type": "array" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[list[LanguageSchema]]" }, "Response_list_SecretListItemSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "title": "Data", "items": { "$ref": "#/components/schemas/SecretListItemSchema" }, "type": "array" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[list[SecretListItemSchema]]" }, "Response_list_VoiceAgentListItemSchema__": { "properties": { "code": { "type": "integer", "title": "Code", "default": 100 }, "data": { "title": "Data", "items": { "$ref": "#/components/schemas/VoiceAgentListItemSchema" }, "type": "array" }, "message": { "title": "Message", "type": "string" } }, "type": "object", "title": "Response[list[VoiceAgentListItemSchema]]" }, "SDKSessionTokenSchema": { "properties": { "session_id": { "type": "string", "format": "uuid", "title": "Session Id" }, "session_token": { "type": "string", "title": "Session Token" } }, "type": "object", "required": [ "session_id", "session_token" ], "title": "SDKSessionTokenSchema" }, "STTConfigSchema-Input": { "properties": { "provider": { "$ref": "#/components/schemas/STTProviderEnum", "description": "STT provider. Auto-selected if not specified." } }, "type": "object", "required": [ "provider" ], "title": "STTConfigSchema", "description": "User-provided STT configuration for sessions." }, "STTConfigSchema-Output": { "properties": { "provider": { "$ref": "#/components/schemas/STTProviderEnum", "description": "STT provider. Auto-selected if not specified." } }, "type": "object", "required": [ "provider" ], "title": "STTConfigSchema", "description": "User-provided STT configuration." }, "STTProviderEnum": { "type": "string", "enum": [ "deepgram", "assembly_ai", "gladia", "elevenlabs" ], "title": "STTProviderEnum" }, "SecretListItemSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "secret_name": { "type": "string", "title": "Secret Name" }, "secret_type": { "$ref": "#/components/schemas/SecretTypeEnum" }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" } }, "type": "object", "required": [ "id", "secret_name", "secret_type" ], "title": "SecretListItemSchema", "description": "Schema for a secret item in list response (no decrypted value)" }, "SecretTypeEnum": { "type": "string", "enum": [ "OPENAI_API_KEY", "ELEVENLABS_API_KEY", "GEMINI_API_KEY", "FISH_API_KEY", "CARTESIA_API_KEY" ], "title": "SecretTypeEnum", "description": "The type of secret." }, "SessionEndReasonEnum": { "type": "string", "enum": [ "UNKNOWN", "USER_DISCONNECTED", "SERVER_ERROR", "IDLE_TIMEOUT", "NO_CREDITS", "USER_CLOSED", "AVATAR_DELETED", "MAX_DURATION_REACHED", "ZOMBIE_SESSION_REAP", "AGENT_HANG_UP", "DISPATCH_FAILED" ], "title": "SessionEndReasonEnum" }, "SessionInteractivityTypeEnum": { "type": "string", "enum": [ "CONVERSATIONAL", "PUSH_TO_TALK" ], "title": "SessionInteractivityTypeEnum" }, "SessionModeEnum": { "type": "string", "enum": [ "FULL", "LITE" ], "title": "SessionModeEnum" }, "SessionSourceEnum": { "type": "string", "enum": [ "DEMO", "APP", "API", "EMBED" ], "title": "SessionSourceEnum" }, "SessionTranscriptDataSchema": { "properties": { "role": { "type": "string", "enum": [ "user", "avatar" ], "title": "Role" }, "transcript": { "type": "string", "title": "Transcript" }, "absolute_timestamp": { "type": "integer", "title": "Absolute Timestamp" }, "relative_timestamp": { "type": "integer", "title": "Relative Timestamp" } }, "type": "object", "required": [ "role", "transcript", "absolute_timestamp", "relative_timestamp" ], "title": "SessionTranscriptDataSchema" }, "SessionTranscriptResponseSchema": { "properties": { "session_active": { "type": "boolean", "title": "Session Active" }, "next_timestamp": { "title": "Next Timestamp", "type": "integer" }, "transcript_data": { "items": { "$ref": "#/components/schemas/SessionTranscriptDataSchema" }, "type": "array", "title": "Transcript Data" } }, "type": "object", "required": [ "session_active", "transcript_data" ], "title": "SessionTranscriptResponseSchema" }, "StartSessionResponseSchema": { "properties": { "session_id": { "type": "string", "title": "Session Id" }, "livekit_url": { "title": "Livekit Url", "type": "string" }, "livekit_client_token": { "title": "Livekit Client Token", "type": "string" }, "livekit_agent_token": { "title": "Livekit Agent Token", "type": "string" }, "max_session_duration": { "title": "Max Session Duration", "type": "integer" }, "ws_url": { "title": "Ws Url", "description": "Websocket URL to send session events to. Custom Mode only.", "type": "string" } }, "type": "object", "required": [ "session_id", "livekit_url", "livekit_client_token" ], "title": "StartSessionResponseSchema" }, "StopSessionSchema": { "properties": { "session_id": { "title": "Session Id", "type": "string", "format": "uuid" }, "reason": { "$ref": "#/components/schemas/SessionEndReasonEnum", "default": "UNKNOWN" } }, "type": "object", "title": "StopSessionSchema" }, "ThirdPartyVoiceBindRequestSchema": { "properties": { "provider_voice_id": { "type": "string", "title": "Provider Voice Id", "description": "Voice ID from the provider (e.g. ElevenLabs voice ID)" }, "secret_id": { "type": "string", "title": "Secret Id", "description": "ID of the space secret containing the provider API key" }, "name": { "title": "Name", "description": "Name of the voice", "type": "string" } }, "type": "object", "required": [ "provider_voice_id", "secret_id" ], "title": "ThirdPartyVoiceBindRequestSchema", "description": "Request body for POST /v1/voices/third_party - bind a third-party voice using a secret." }, "ThirdPartyVoiceBindResponseSchema": { "properties": { "voice_id": { "type": "string", "title": "Voice Id", "description": "Voice ID saved on LiveAvatar side" } }, "type": "object", "required": [ "voice_id" ], "title": "ThirdPartyVoiceBindResponseSchema", "description": "Response from POST /v1/voices/third_party." }, "UpdateAvatarSchema": { "properties": { "name": { "title": "Name", "type": "string" }, "default_voice_id": { "title": "Default Voice Id", "type": "string" } }, "type": "object", "title": "UpdateAvatarSchema" }, "UpdateContextSchema": { "properties": { "name": { "type": "string", "maxLength": 64, "title": "Name" }, "prompt": { "type": "string", "title": "Prompt" }, "opening_text": { "title": "Opening Text", "type": "string" }, "links": { "title": "Links", "items": { "$ref": "#/components/schemas/CreateUpdateContextLinkSchema" }, "type": "array" } }, "type": "object", "required": [ "name", "prompt", "opening_text" ], "title": "UpdateContextSchema" }, "UpdateLLMConfigurationSchema": { "properties": { "base_url": { "title": "Base Url", "description": "The LLM API endpoint URL", "type": "string", "minLength": 1 }, "display_name": { "title": "Display Name", "description": "Display name for the configuration", "type": "string", "maxLength": 255, "minLength": 1 }, "model_name": { "title": "Model Name", "description": "The model name to use", "type": "string", "maxLength": 255, "minLength": 1 }, "secret_id": { "title": "Secret Id", "description": "ID of the secret containing the API key", "type": "string", "maxLength": 36, "minLength": 1 } }, "type": "object", "title": "UpdateLLMConfigurationSchema", "description": "Request schema for updating an LLM configuration" }, "UpdateVoiceSchema": { "properties": { "name": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Name" } }, "type": "object", "required": [ "name" ], "title": "UpdateVoiceSchema" }, "UserCreditsSchema": { "properties": { "credits_left": { "title": "Credits Left", "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" } }, "type": "object", "required": [ "credits_left" ], "title": "UserCreditsSchema" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "VideoEncodingEnum": { "type": "string", "enum": [ "VP8", "H264" ], "title": "VideoEncodingEnum" }, "VideoQualityEnum": { "type": "string", "enum": [ "very_high", "high", "medium", "low" ], "title": "VideoQualityEnum" }, "VideoSettings": { "properties": { "quality": { "$ref": "#/components/schemas/VideoQualityEnum", "default": "high" }, "encoding": { "$ref": "#/components/schemas/VideoEncodingEnum", "default": "H264" } }, "type": "object", "title": "VideoSettings", "description": "Video encoding settings for session configuration" }, "VoiceAgentListItemSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "agent_type": { "$ref": "#/components/schemas/VoiceAgentTypeEnum" }, "is_public": { "type": "boolean", "title": "Is Public" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "agent_type", "is_public", "created_at", "updated_at" ], "title": "VoiceAgentListItemSchema", "description": "A voice agent without its `agent_configuration`, as returned by the list endpoint." }, "VoiceAgentRef": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id", "description": "Stored voice_agent id. Its server-resolved agent_type determines which of the override fields below are accepted." }, "language": { "title": "Language", "description": "Per-session language override, layered over the agent's stored language. Accepted only for a liveavatar_agent; rejected with a 400 for an elevenlabs_agent.", "type": "string" }, "dynamic_variables": { "title": "Dynamic Variables", "description": "Per-session dynamic_variables override. Accepted only for a liveavatar_agent, where values must be strings (substituted as text into the context's ${var} placeholders; non-string values are rejected with a 400). Rejected with a 400 for an elevenlabs_agent. Mutually exclusive with the top-level dynamic_variables (400 if both set). At most 50 entries; keys <= 64 chars; string values <= 1000 chars.", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "object" } }, "type": "object", "required": [ "id" ], "title": "VoiceAgentRef", "description": "Reference to a stored voice_agent, plus optional per-session overrides.\n\nThe caller passes only the agent ``id``; the server resolves the stored\nagent's ``agent_type`` and decides how the session is built. The override\nfields below are NOT universal \u2014 which ones are accepted depends on the\nresolved type, and an override that doesn't apply is rejected (400) rather\nthan silently ignored:\n\n* ``liveavatar_agent`` (managed STT -> LLM -> TTS pipeline): ``language``\n and ``dynamic_variables`` are honored, layered over the stored agent's\n config for this session only.\n* ``elevenlabs_agent`` (ElevenLabs-hosted): the stored agent is used as-is;\n passing ``language`` or ``dynamic_variables`` is rejected with a 400.\n\nOverrides are per-session-at-creation choices, not properties of the stored\nagent \u2014 the same agent is reused across sessions with different values each\ntime, and the resolved result is what gets frozen into the session snapshot.\nShared across the SDK and app token requests.\n\n``dynamic_variables`` is typed as the bounded union for forward-compatibility\n(a single wire type across agent types); the server narrows or rejects it per\nthe resolved ``agent_type`` as described on the field." }, "VoiceAgentResponseSchema": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "agent_type": { "$ref": "#/components/schemas/VoiceAgentTypeEnum" }, "is_public": { "type": "boolean", "title": "Is Public" }, "agent_configuration": { "oneOf": [ { "$ref": "#/components/schemas/FullAgentConfigSchema" }, { "$ref": "#/components/schemas/ElevenLabsAgentConfigSchema-Output" }, { "$ref": "#/components/schemas/CartesiaAgentConfigSchema-Output" } ], "title": "Agent Configuration", "discriminator": { "propertyName": "agent_type", "mapping": { "cartesia_agent": "#/components/schemas/CartesiaAgentConfigSchema-Output", "elevenlabs_agent": "#/components/schemas/ElevenLabsAgentConfigSchema-Output", "liveavatar_agent": "#/components/schemas/FullAgentConfigSchema" } } }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "name", "agent_type", "is_public", "agent_configuration", "created_at", "updated_at" ], "title": "VoiceAgentResponseSchema", "description": "A voice agent, including its full `agent_configuration`." }, "VoiceAgentScopeEnum": { "type": "string", "enum": [ "private", "public" ], "title": "VoiceAgentScopeEnum", "description": "Which agents `GET /v1/voice_agents` returns.\n\nA distinct dimension from `agent_type` (how the conversation runs): `scope` is\nabout ownership. `private` is the default so existing callers keep seeing exactly\nthe set they own today.\n\nNamed `scope` rather than `voice_agent_type` (voices' `voice_type` precedent)\nbecause `agent_type` is already taken on this resource.\n\n* `private` \u2014 only the caller's space owns.\n* `public` \u2014 presets owned by no space (`space_id IS NULL`); read-only to everyone." }, "VoiceAgentTypeEnum": { "type": "string", "enum": [ "liveavatar_agent", "elevenlabs_agent", "cartesia_agent" ], "title": "VoiceAgentTypeEnum", "description": "How a voice agent's conversation is run.\n\n* `liveavatar_agent` \u2014 the managed speech-to-text => LLM => text-to-speech pipeline.\n* `elevenlabs_agent` \u2014 an agent you host on ElevenLabs, referenced by id.\n* `cartesia_agent` \u2014 an agent you host on Cartesia, referenced by id." }, "VoiceListTypeEnum": { "type": "string", "enum": [ "public", "private" ], "title": "VoiceListTypeEnum" }, "VoicePreviewResponseSchema": { "properties": { "audio_base64": { "type": "string", "title": "Audio Base64" } }, "type": "object", "required": [ "audio_base64" ], "title": "VoicePreviewResponseSchema" }, "VoiceSchema": { "properties": { "id": { "type": "string", "format": "uuid", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "title": "Description", "type": "string" }, "language": { "type": "string", "title": "Language" }, "gender": { "type": "string", "title": "Gender" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" }, "tags": { "items": { "type": "string" }, "type": "array", "title": "Tags", "readOnly": true } }, "type": "object", "required": [ "id", "name", "language", "gender", "created_at", "updated_at", "tags" ], "title": "VoiceSchema" } }, "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "X-API-KEY" }, "HTTPBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }