Skip to main content
POST
Create Session

Authorizations

PersoPlatform-APIKey
string
header
required

Body

prompt
string | null

Prompt identifier defining the system prompt + intro message. Mutually exclusive with interactive_agent_config.

Minimum string length: 1
capability
enum<string>[]

List of session capabilities to enable (e.g. STF_WEBRTC, STT, LLM).

  • LLM - LLM
  • TTS - TTS
  • STT - STT
  • STF_ONPREMISE - STF_ONPREMISE
  • STF_WEBRTC - STF_WEBRTC
Available options:
LLM,
TTS,
STT,
STF_ONPREMISE,
STF_WEBRTC
document
string | null

Optional document identifier to attach as a knowledge source.

Minimum string length: 1
llm_type
string | null

LLM model identifier (use List LLM Types). Mutually exclusive with interactive_agent_config.

Minimum string length: 1
tts_type
string | null

TTS voice/type identifier (use List TTS Types).

Minimum string length: 1
text_normalization_config
string | null

Identifier of the text-normalization config applied to TTS input. Configs bundle regex rulesets that rewrite text before speech synthesis (e.g. 20℉화씨 20도, ₩1,0001,000 원).

Minimum string length: 1
text_normalization_locale
string | null

Locale code (e.g. ko-KR) used to select locale-specific rules from the configured ruleset. If omitted, only locale-agnostic rules run; if set, both locale-agnostic and matching-locale rules run.

Maximum string length: 10
stt_type
string | null

STT engine identifier (use List STT Types). Required only if STT capability is in capability.

Minimum string length: 1
stt_text_normalization_config
string | null

Identifier of the text-normalization config applied to STT output. Same ruleset mechanism as TTS normalization but runs on the transcribed text before it is forwarded to the LLM.

Minimum string length: 1
stt_text_normalization_locale
string | null

Locale code used to select locale-specific rules from the STT normalization config. Behaviour matches text_normalization_locale.

Maximum string length: 10
model_style
string | null

Model style name controlling the avatar's visual style (use List Model Styles).

Minimum string length: 1
agent
string | null

Legacy free-form agent identifier string (deprecated — prefer agent_config).

Maximum string length: 255
agent_config
string | null

Optional agent designer config identifier to drive a tool-using agent.

Minimum string length: 1
interactive_agent_config
string | null

Optional interactive-agent config identifier (pliac-*). When set, llm.request turns run on the external interactive-agent server instead of a single-shot completion. Cannot be combined with llm_type or prompt — providing either alongside is rejected.

Minimum string length: 1
padding_left
number<double> | null

Horizontal avatar position offset, between -1.0 and 1.0. Negative = left, positive = right of frame center.

Required range: -1 <= x <= 1
padding_top
number<double> | null

Vertical avatar position offset from the top, between 0.0 and 1.0 of the frame height.

Required range: 0 <= x <= 1
padding_height
number<double> | null

Avatar height scale multiplier (0-5); 1.0 = unscaled.

Required range: 0 <= x <= 5
background_image
string | null

Optional background image identifier for the avatar scene.

Minimum string length: 1
extra_data
any | null

Free-form JSON payload stored alongside the session for caller-defined metadata.

mcp_servers
string[]

List of MCP server names available to the LLM during the session (use List MCP Types).

Minimum string length: 1

Response

session_id
string
required
read-only
created_at
string<date-time>
required
read-only
status
enum<string>
required
  • CREATED - Created
  • EXCHANGED - Exchanged
  • IN_PROGRESS - In Progress
  • TERMINATED - Terminated
Available options:
CREATED,
EXCHANGED,
IN_PROGRESS,
TERMINATED
prompt
string | null

Prompt identifier defining the system prompt + intro message. Mutually exclusive with interactive_agent_config.

capability
enum<string>[]

List of session capabilities to enable (e.g. STF_WEBRTC, STT, LLM).

  • LLM - LLM
  • TTS - TTS
  • STT - STT
  • STF_ONPREMISE - STF_ONPREMISE
  • STF_WEBRTC - STF_WEBRTC
Available options:
LLM,
TTS,
STT,
STF_ONPREMISE,
STF_WEBRTC
document
string | null

Optional document identifier to attach as a knowledge source.

llm_type
string | null

LLM model identifier (use List LLM Types). Mutually exclusive with interactive_agent_config.

tts_type
string | null

TTS voice/type identifier (use List TTS Types).

text_normalization_config
string | null

Identifier of the text-normalization config applied to TTS input. Configs bundle regex rulesets that rewrite text before speech synthesis (e.g. 20℉화씨 20도, ₩1,0001,000 원).

text_normalization_locale
string | null

Locale code (e.g. ko-KR) used to select locale-specific rules from the configured ruleset. If omitted, only locale-agnostic rules run; if set, both locale-agnostic and matching-locale rules run.

Maximum string length: 10
stt_type
string | null

STT engine identifier (use List STT Types). Required only if STT capability is in capability.

stt_text_normalization_config
string | null

Identifier of the text-normalization config applied to STT output. Same ruleset mechanism as TTS normalization but runs on the transcribed text before it is forwarded to the LLM.

stt_text_normalization_locale
string | null

Locale code used to select locale-specific rules from the STT normalization config. Behaviour matches text_normalization_locale.

Maximum string length: 10
model_style
string | null

Model style name controlling the avatar's visual style (use List Model Styles).

agent
string | null

Legacy free-form agent identifier string (deprecated — prefer agent_config).

Maximum string length: 255
agent_config
string | null

Optional agent designer config identifier to drive a tool-using agent.

interactive_agent_config
string | null

Optional interactive-agent config identifier (pliac-*). When set, llm.request turns run on the external interactive-agent server instead of a single-shot completion. Cannot be combined with llm_type or prompt — providing either alongside is rejected.

padding_left
number<double> | null

Horizontal avatar position offset, between -1.0 and 1.0. Negative = left, positive = right of frame center.

Required range: -1 <= x <= 1
padding_top
number<double> | null

Vertical avatar position offset from the top, between 0.0 and 1.0 of the frame height.

Required range: 0 <= x <= 1
padding_height
number<double> | null

Avatar height scale multiplier (0-5); 1.0 = unscaled.

Required range: 0 <= x <= 5
background_image
string | null

Optional background image identifier for the avatar scene.

extra_data
any | null

Free-form JSON payload stored alongside the session for caller-defined metadata.

mcp_servers
string[]

List of MCP server names available to the LLM during the session (use List MCP Types).