The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.
Test your agent
Test how your agent responds to user actions.
Paste in your agent
1. Set up Voiceflow by following https://www.voiceflow.com/agents/setup 2. Read https://www.voiceflow.com/docs/api-reference/resources/conversation.md — the Voiceflow documentation page "Test your agent". Use it to help me with this part of Voiceflow and answer my questions. Refer to https://www.voiceflow.com/docs/llms.txt if you need related documentation.
See Authentication for credentials and permissions.
/v1/stable/conversation/{userID}Send one action to test your agent against a draft or published environment. Use launch to start the conversation, then text to send a user message.
Request examples
- Launch
- Text
Start a conversation by sending a launch action to this endpoint. Launch is a request type, not a separate route.
{
"action": {
"type": "launch"
},
"version": "draft"
} Send a user message to continue the conversation. Use the same user ID or session as the launch request.
{
"action": {
"type": "text",
"payload": "Where is my order?"
},
"version": "draft"
} curl --request PUT \
--url 'https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'PUT',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}),
});
const data = await response.json();import requests
response = requests.put(
'https://realtime-api.voiceflow.com/v1/stable/conversation/<userID>?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
},
)
data = response.json()vf conversation send --user-id <userID> --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"version": "draft",
"sessionID": "<string>",
"config": {
"excludeTypes": [
"<TraceType>"
]
}
}
JSON{
"traces": [
{
"type": "audio",
"paths": [
"<TracePath>"
],
"defaultPath": 0,
"time": 0,
"turnID": "<string>",
"handleID": "<string>",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 0
}
}
],
"needsRecompile": true
}Path parameters
Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
Whether to run the conversation against the draft or published version of the environment.
draft, publishedMore parameters
sessionIDstring
The unique ID of the conversation session to continue.
configobject
Options controlling how the response is shaped.
Show child attributes
Trace types to drop from the response. Opt-in — when omitted, every trace is returned.
Response
200 - application/jsonReturns the agent's response to the turn as an array of traces, each a typed piece of the reply such as text, speech, a card or carousel, a choice, a tool call, or a debug entry.
When true, this turn ran against a stale prototype. Compile the environment and send again; do not treat these traces as proof the latest edits work.
/v1/stable/conversation/scriptTest a short conversation in one request. The script launches the agent automatically, then sends your messages in order and returns the results.
curl --request POST \
--url 'https://realtime-api.voiceflow.com/v1/stable/conversation/script?projectID=<projectID>&environmentAlias=<environmentAlias>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"messages": [
"<string>"
],
"variables": {},
"version": "draft",
"launch": {
"payload": {
"persona": "<string>"
}
},
"userID": "<string>"
}'const response = await fetch('https://realtime-api.voiceflow.com/v1/stable/conversation/script?projectID=<projectID>&environmentAlias=<environmentAlias>', {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"messages": [
"<string>"
],
"variables": {},
"version": "draft",
"launch": {
"payload": {
"persona": "<string>"
}
},
"userID": "<string>"
}),
});
const data = await response.json();import requests
response = requests.post(
'https://realtime-api.voiceflow.com/v1/stable/conversation/script?projectID=<projectID>&environmentAlias=<environmentAlias>',
headers={'Authorization': 'Bearer <token>'},
json={
"messages": [
"<string>"
],
"variables": {},
"version": "draft",
"launch": {
"payload": {
"persona": "<string>"
}
},
"userID": "<string>"
},
)
data = response.json()vf conversation run-script --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
"messages": [
"<string>"
],
"variables": {},
"version": "draft",
"launch": {
"payload": {
"persona": "<string>"
}
},
"userID": "<string>"
}
JSON{
"userID": "<string>",
"transcriptID": "<string>",
"needsRecompile": true,
"turns": [
{
"user": "<string>",
"agent": [
"<string>"
],
"repliedBy": [
"<string>"
],
"toolCalls": [
"<StableConversationScriptToolCall>"
],
"variableChanges": [
"<StableConversationScriptVariableChange>"
],
"errors": [
"<string>"
],
"warnings": [
"<string>"
],
"ended": true,
"endedBy": "<string>"
}
],
"notSent": [
"<string>"
]
}Query parameters
The ID of the project to operate on.
The alias of the environment to operate on (e.g. main).
Request body
The user messages to send, in order, after the launch. A message is typed text, as a string or { "text": "…" }, or a button press, as { "button": "<label>" }, for a button the reply before offered. The digest shows offered buttons as "[buttons: Yes | No]".
Show child attributes
Variable values to set before the launch, keyed by variable name, to start as a known caller. Next to messages, not inside launch.
Whether to talk to the draft or the published version of the environment. Draft unless you pass it.
draft, publishedHow the conversation starts; payload is its only field. Leave it out for a plain launch.
Show child attributes
The launch payload, as a website passes it to the chat widget, for example { "lang": "de" }. The agent reads it from the last_event variable.
Show child attributes
The conversation user ID to run as; the agent reads it as the user_id variable. Use it when the agent expects a caller ID of a known shape, such as a phone number, and make one up: never a real customer's ID. Draft version only. Leave it out to run as a new user each time. A reused ID keeps the variables an earlier conversation with it left.
Response
200 - application/jsonReturns one digest per turn: the agent's replies, the tools it called, the variables that changed, and any errors. Messages that were not sent because the script stopped early come back in notSent, and needsRecompile says whether the turns ran against an outdated compile.
The conversation user ID the script ran as, for reading its state afterwards.
The transcript this conversation is saved to, for reading its logs. Null when the runtime reported none, for example when the project does not save test conversations; then search transcripts with sessionID set to userID.
When true, the script ran against a stale prototype. Compile the environment and run it again; do not treat these turns as proof the latest edits work.
The launch turn first, then one turn per message sent.
Steps that were not run, in the same form as user, because the conversation ended, a send failed, a button was not on offer, the runtime logged an error outside a tool or a fatal error, the credit limit was reached, or the caller stopped the script first. A failed tool or HTTP call does not stop the script: it is listed in its turn.
Current - 2026/04
/v4/interactSend one action directly to the conversation runtime over REST. Choose the current or legacy contract above; the current contract requires a session key, while legacy uses your API key and user ID.
Request examples
- Launch
- Text
Start a conversation by sending a launch action to this endpoint. Launch is a request type, not a separate route.
{
"action": {
"type": "launch"
}
} Send a user message to continue the conversation. Use the same user ID or session as the launch request.
{
"action": {
"type": "text",
"payload": "Where is my order?"
}
} curl --request POST \
--url 'https://general-runtime.voiceflow.com/v4/interact' \
--header 'Authorization: <session-key>' \
--header 'Content-Type: application/json' \
--data '{
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"variables": {},
"state": null,
"config": {
"userTimezone": "<string>",
"excludeTypes": [
"log"
]
}
}'const response = await fetch('https://general-runtime.voiceflow.com/v4/interact', {
method: 'POST',
headers: {
Authorization: '<session-key>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"variables": {},
"state": null,
"config": {
"userTimezone": "<string>",
"excludeTypes": [
"log"
]
}
}),
});
const data = await response.json();import requests
response = requests.post(
'https://general-runtime.voiceflow.com/v4/interact',
headers={'Authorization': '<session-key>'},
json={
"action": {
"type": "launch",
"payload": {
"persona": "<string>"
},
"diagramID": "<string>",
"time": 0,
"metadata": {}
},
"variables": {},
"state": None,
"config": {
"userTimezone": "<string>",
"excludeTypes": [
"log"
]
}
},
)
data = response.json(){
"traces": [
{
"type": "audio",
"paths": [
"<TestingRuntime_TracePath>"
],
"defaultPath": 0,
"time": 0,
"turnID": "<string>",
"handleID": "<string>",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 0
}
}
]
}{
"traces": [
{
"type": "audio",
"paths": [
"<TestingRuntime_TracePath>"
],
"defaultPath": 0,
"time": 0,
"turnID": "<string>",
"handleID": "<string>",
"payload": {
"state": "start",
"messageID": "<string>",
"delay": 0
}
}
]
}Authentication
Session key returned from the start session endpoint.
Request body
The user's action for this conversation turn. Most commonly, the text action is used to send a message to the agent as a user.
Show child attributes
Key-value pairs to set or update on the session before this turn is processed. Useful for injecting context like a user's name, account tier, or current page. Learn more.
Optional settings for this turn.
Show child attributes
The user's IANA timezone string (eg: America/New_York). Sets {vf_user_timezone} variable. Used to localize time-dependent agent behavior.
Trace types to omit from the response, for example ["block", "debug", "flow", "path"]. Omit this field to receive every trace. A debug trace reporting credit_limit_reached is always returned, since it is what explains a 402 response.
Response
200 - application/jsonAn array of traces that occurred during this turn.
Error 402
application/jsonReturned when the turn produces nothing but a credit_limit_reached debug trace (the account has exhausted its available credits). The response body has the same shape as a 200 response.
An array of traces that occurred during this turn.
Legacy - 2021/04
/state/user/{userID}/interactSend one action directly to the conversation runtime over REST. Choose the current or legacy contract above; the current contract requires a session key, while legacy uses your API key and user ID.
Request examples
- Launch
- Text
Start a conversation by sending a launch action to this endpoint. Launch is a request type, not a separate route.
{
"action": {
"type": "launch"
}
} Send a user message to continue the conversation. Use the same user ID or session as the launch request.
{
"action": {
"type": "text",
"payload": "Where is my order?"
}
} curl --request POST \
--url 'https://general-runtime.voiceflow.com/state/user/<userID>/interact' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"state": {
"variables": {}
},
"request": null,
"action": null,
"config": null
}'const response = await fetch('https://general-runtime.voiceflow.com/state/user/<userID>/interact', {
method: 'POST',
headers: {
Authorization: '<api-key>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"state": {
"variables": {}
},
"request": null,
"action": null,
"config": null
}),
});
// This operation returns no response body.
console.log(response.status);import requests
response = requests.post(
'https://general-runtime.voiceflow.com/state/user/<userID>/interact',
headers={'Authorization': '<api-key>'},
json={
"state": {
"variables": {}
},
"request": None,
"action": None,
"config": None
},
)
response.raise_for_status()
# This operation returns no response body.Authentication
Voiceflow API key
Path parameters
An ID which uniquely identifies the user having the conversation.
Request body
Show child attributes
The user's response, e.g, user requests starting a conversation or advances the conversation by providing some textual response.
Optional settings to configure the response.
Response
200Schemas
ActionRequest
Actions are self-describing operations with an associated payload.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["action"],"x-enumNames":["ACTION"]} |
payload | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"BaseAction"}},"label":{"type":"string"}},"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
AlexaIntentRequest
Legacy intent request type that general-runtime expects Alexa to send
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
payload · required | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"BaseAction"}},"label":{"type":"string"},"data":{"type":"object","additionalProperties":{}},"query":{"default":"","type":"string"},"intent":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":{}},"entities":{"default":[],"type":"array","items":{"$ref":"IntentRequestEntity"}},"confidence":{"type":"number"}},"required":["data","intent","entities"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
AnyRequest
{"anyOf":[{"$ref":"LaunchRequest"},{"$ref":"TextRequest"},{"$ref":"FileRequest"},{"$ref":"ActionRequest"},{"$ref":"IntentRequest"},{"$ref":"EventRequest"},{"$ref":"PathRequest"},{"$ref":"NoReplyRequest"},{"$ref":"MessageRequest"},{"$ref":"EndRequest"},{"$ref":"DTMFRequest"},{"$ref":"LiveAgentHandoffRequest"},{"$ref":"GeneralRequest"},{"$ref":"AlexaIntentRequest"},{"$ref":"LegacyIntentRequest"}]}
AnyTrace
{"oneOf":[{"$ref":"AudioTrace"},{"$ref":"SpeakTrace"},{"$ref":"StreamTrace"},{"$ref":"BlockTrace"},{"$ref":"CardTrace"},{"$ref":"CarouselTrace"},{"$ref":"ChannelActionTrace"},{"$ref":"ChoiceTrace"},{"$ref":"CompletionTrace"},{"$ref":"DebugTrace"},{"$ref":"DTMFTrace"},{"$ref":"EntityFillingTrace"},{"$ref":"ExitTrace"},{"$ref":"FlowTrace"},{"$ref":"GoToTrace"},{"$ref":"LogTrace"},{"$ref":"NoReplyTrace"},{"$ref":"PathTrace"},{"$ref":"TextTrace"},{"$ref":"ReasoningTrace"},{"$ref":"VisualTrace"},{"$ref":"KnowledgeBaseTrace"},{"$ref":"CallForwardTrace"},{"$ref":"RealtimeAgentTrace"},{"$ref":"LiveAgentHandoffTrace"},{"$ref":"ToolCallTrace"}]}
AudioEncoding / TestingRuntime_AudioEncoding
{"type":"string","enum":["audio/mp3","audio/x-mulaw","audio/pcm"],"x-enumNames":["MP_3","MULAW","PCM"]}
AudioTrace
An audio response event. The payload's state field selects the shape: start announces a messageID, content carries base64-encoded audio in content with its encoding, and end carries the state alone.
{"type":"object","x-vf-doc":{"description":"An audio response event. The payload's `state` field selects the shape: `start` announces a `messageID`, `content` carries base64-encoded audio in `content` with its `encoding`, and `end` carries the state alone."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["audio"],"x-enumNames":["AUDIO"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["start"],"x-enumNames":["START"]},"messageID":{"type":"string"},"delay":{"type":"number"}},"required":["state","messageID"]},{"type":"object","properties":{"state":{"type":"string","enum":["content"],"x-enumNames":["CONTENT"]},"content":{"type":"string"},"encoding":{"$ref":"AudioEncoding"},"duration":{"type":"number"}},"required":["state","content","encoding"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]}},"required":["state"]}]} |
BaseAction / TestingRuntime_BaseAction
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
payload · required | {} |
BaseRequest / TestingRuntime_BaseRequest
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
payload | {} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
BlockTrace
Marks the conversation entering a block, identified by its block ID.
{"type":"object","x-vf-doc":{"description":"Marks the conversation entering a block, identified by its block ID."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["block"],"x-enumNames":["BLOCK"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"blockID":{"type":"string"}},"required":["blockID"]} |
Button
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
request | {"allOf":[{"$ref":"BaseRequest"}]} |
CallForwardPhone / TestingRuntime_CallForwardPhone
{"type":"object"}
| Property | Definition |
|---|---|
addressType · required | {"type":"string","enum":["phone"],"x-enumNames":["PHONE"]} |
address · required | {"type":"string"} |
extension | {"type":"string"} |
callerIDPassthrough | {"type":"boolean"} |
CallForwardSIP / TestingRuntime_CallForwardSIP
{"type":"object"}
| Property | Definition |
|---|---|
addressType · required | {"type":"string","enum":["sip"],"x-enumNames":["SIP"]} |
address · required | {"type":"string"} |
CallForwardTrace
Signals that the call is being forwarded. The payload always carries the destination in address and its kind in addressType; a phone forward may also carry an extension and a callerIDPassthrough flag. See the call forward step for configuration.
{"type":"object","x-vf-doc":{"description":"Signals that the call is being forwarded. The payload always carries the destination in `address` and its kind in `addressType`; a `phone` forward may also carry an `extension` and a `callerIDPassthrough` flag. See the call forward step for configuration."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["call-forward"],"x-enumNames":["CALL_FORWARD"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"$ref":"CallForwardPhone"},{"$ref":"CallForwardSIP"}]} |
CanvasVisibility / TestingRuntime_CanvasVisibility
{"type":"string","enum":["full","hidden","cropped"],"x-enumNames":["FULL","HIDDEN","CROPPED"]}
CardTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["cardV2"],"x-enumNames":["CARD_V_2"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"$ref":"CardTraceCard"} |
CardTraceCard
{"type":"object"}
| Property | Definition |
|---|---|
ref | {"allOf":[{"$ref":"DebugTraceRef"}]} |
title · required | {"type":"string"} |
buttons · required | {"type":"array","items":{"$ref":"Button"}} |
imageUrl · required | {"nullable":true,"type":"string"} |
messageID | {"type":"string"} |
description · required | {"type":"object","properties":{"text":{"type":"string"},"slate":{"type":"array","items":{}}},"required":["text"]} |
CarouselLayout / TestingRuntime_CarouselLayout
{"type":"string","enum":["List","Carousel"],"x-enumNames":["LIST","CAROUSEL"]}
CarouselTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["carousel"],"x-enumNames":["CAROUSEL"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ref":{"allOf":[{"$ref":"DebugTraceRef"}]},"cards":{"type":"array","items":{"$ref":"TraceCarouselCard"}},"layout":{"$ref":"CarouselLayout"},"messageID":{"type":"string"}},"required":["cards","layout"]} |
ChannelActionTrace
A channel-specific action, named by the channel integration, with an action-defined payload.
{"type":"object","x-vf-doc":{"description":"A channel-specific action, named by the channel integration, with an action-defined payload."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["channel-action"],"x-enumNames":["CHANNEL_ACTION"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"name":{"type":"string"},"payload":{"type":"object","additionalProperties":{}}},"required":["name","payload"]} |
ChoiceTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["choice"],"x-enumNames":["CHOICE"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ref":{"allOf":[{"$ref":"DebugTraceRef"}]},"buttons":{"type":"array","items":{"$ref":"Button"}},"messageID":{"type":"string"}},"required":["buttons"]} |
CompletionTrace
Marks a model completion event during the turn. Streaming clients receive the completion lifecycle described under completion event traces.
{"type":"object","x-vf-doc":{"description":"Marks a model completion event during the turn. Streaming clients receive the completion lifecycle described under completion event traces."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["completion"],"x-enumNames":["COMPLETION"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["start"],"x-enumNames":["START"]},"ai":{"type":"boolean"},"sourceUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url"]}},"delay":{"type":"number"},"messageID":{"type":"string"},"ref":{"allOf":[{"$ref":"DebugTraceRef"}]}},"required":["state","messageID"]},{"type":"object","properties":{"state":{"type":"string","enum":["content"],"x-enumNames":["CONTENT"]},"content":{"type":"string"},"messageID":{"type":"string"}},"required":["state","content"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]},"ref":{"allOf":[{"$ref":"DebugTraceRef"}]},"sourceUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url"]}},"messageID":{"type":"string"}},"required":["state"]}]} |
DTMFDelimiter / TestingRuntime_DTMFDelimiter
{"type":"string","enum":["#","*"],"x-enumNames":["#","*"]}
DTMFRequest
Represents the result of a dial-tone input, used for phone calls.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["dtmf"],"x-enumNames":["DTMF"]} |
payload · required | {"type":"string"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
DTMFTrace
Configures keypad (DTMF) input collection on a call: whether it is enabled, the timeout, the ending delimiter, and the digit cap.
{"type":"object","x-vf-doc":{"description":"Configures keypad (DTMF) input collection on a call: whether it is enabled, the timeout, the ending delimiter, and the digit cap."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["dtmf"],"x-enumNames":["DTMF"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"$ref":"DTMFTracePayload"} |
DTMFTracePayload
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | Enables the new DTMF collection and configuration {"type":"boolean"} |
timeoutInSeconds · required | How long to wait before processing the DTMF input. Set to 0 to process only after a delimiter is provided. {"type":"number","minimum":0,"maximum":10} |
delimiter · required | Which key to use to end DTMF input. Defaults to '#' {"type":"array","items":{"$ref":"DTMFDelimiter"}} |
maxDigits · required | The maximum number of digits before we finish their input {"type":"number","minimum":1,"maximum":20} |
DebugTrace
Debug output for the turn, with a message and optional level, context, and metadata. Surfaced in agent logs rather than to end users.
{"type":"object","x-vf-doc":{"description":"Debug output for the turn, with a message and optional level, context, and metadata. Surfaced in agent logs rather than to end users."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["debug"],"x-enumNames":["DEBUG"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ref":{"allOf":[{"$ref":"DebugTraceRef"}]},"type":{"type":"string"},"level":{"allOf":[{"$ref":"DebugTraceLevel"}]},"message":{"type":"string"},"context":{"type":"string"},"metadata":{"type":"object","additionalProperties":{}}},"required":["message"]} |
DebugTraceAPIToolRef / TestingRuntime_DebugTraceAPIToolRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["api-tool"],"x-enumNames":["API_TOOL"]} |
nodeID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
apiToolID · required | {"type":"string"} |
apiToolName | {"type":"string"} |
diagramName | {"type":"string"} |
DebugTraceAgentRef / TestingRuntime_DebugTraceAgentRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["agent"],"x-enumNames":["AGENT"]} |
nodeID · required | {"type":"string"} |
agentID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
agentName | {"type":"string"} |
diagramName | {"type":"string"} |
DebugTraceFunctionRef / TestingRuntime_DebugTraceFunctionRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["function"],"x-enumNames":["FUNCTION"]} |
nodeID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
functionID · required | {"type":"string"} |
functionName | {"type":"string"} |
diagramName | {"type":"string"} |
DebugTraceIntegrationToolRef / TestingRuntime_DebugTraceIntegrationToolRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["integration-tool"],"x-enumNames":["INTEGRATION_TOOL"]} |
nodeID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
diagramName | {"type":"string"} |
integrationToolName · required | {"type":"string"} |
DebugTraceLevel / TestingRuntime_DebugTraceLevel
{"type":"string","enum":["fatal","error","warn","info","debug"],"x-enumNames":["FATAL","ERROR","WARN","INFO","DEBUG"]}
DebugTraceMcpIntegrationToolRef / TestingRuntime_DebugTraceMcpIntegrationToolRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["mcp-integration-tool"],"x-enumNames":["MCP_INTEGRATION_TOOL"]} |
nodeID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
mcpToolName · required | {"type":"string"} |
diagramName | {"type":"string"} |
DebugTraceNodeRef / TestingRuntime_DebugTraceNodeRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["node"],"x-enumNames":["NODE"]} |
nodeID · required | {"type":"string"} |
nodeType · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
diagramName | {"type":"string"} |
DebugTracePromptRef / TestingRuntime_DebugTracePromptRef
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["prompt"],"x-enumNames":["PROMPT"]} |
nodeID · required | {"type":"string"} |
promptID · required | {"type":"string"} |
diagramID · required | {"type":"string"} |
diagramName | {"type":"string"} |
DebugTraceRef
{"oneOf":[{"$ref":"DebugTraceNodeRef"},{"$ref":"DebugTraceAgentRef"},{"$ref":"DebugTracePromptRef"},{"$ref":"DebugTraceAPIToolRef"},{"$ref":"DebugTraceFunctionRef"},{"$ref":"DebugTraceIntegrationToolRef"},{"$ref":"DebugTraceMcpIntegrationToolRef"}]}
EndRequest
Sent to indicate the conversation has been ended.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["end"],"x-enumNames":["END"]} |
payload | {"type":"object","properties":{"reason":{"type":"string"},"message":{"type":"string"}},"required":["reason"],"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
EntityFillingTrace
Requests a value for a named entity, wrapping the intent request being filled.
{"type":"object","x-vf-doc":{"description":"Requests a value for a named entity, wrapping the intent request being filled."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["entity-filling"],"x-enumNames":["ENTITY_FILLING"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"entityToFill":{"type":"string"},"intent":{"$ref":"IntentRequest"}},"required":["entityToFill","intent"]} |
EventRequest
Events are triggers with an associated payload.
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["event"],"x-enumNames":["EVENT"]} |
payload · required | {"$ref":"EventRequestPayload"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
EventRequestPayload
{"type":"object"}
| Property | Definition |
|---|---|
actions | {"type":"array","items":{"$ref":"BaseAction"}} |
label | {"type":"string"} |
event · required | {"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":{}} |
ExitTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["end"],"x-enumNames":["END"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload | {} |
FileRequest
Send one or more file attachments, with an optional text message.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["file"],"x-enumNames":["FILE"]} |
payload · required | {"type":"object","properties":{"text":{"type":"string"},"files":{"minItems":1,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"mimeType":{"type":"string"},"filename":{"type":"string"},"size":{"type":"number"},"s3Key":{"type":"string"}},"required":["mimeType"],"additionalProperties":{}}}},"required":["files"],"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
FlowTrace
Marks the conversation entering a flow, identified by its diagram ID.
{"type":"object","x-vf-doc":{"description":"Marks the conversation entering a flow, identified by its diagram ID."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["flow"],"x-enumNames":["FLOW"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"name":{"type":"string"},"diagramID":{"type":"string"}},"required":["diagramID"]} |
GeneralRequest
Represents an non-system-defined action.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
payload | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"BaseAction"}},"label":{"type":"string"}},"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
GoToTrace
Instructs the client to re-send the wrapped request on the next turn.
{"type":"object","x-vf-doc":{"description":"Instructs the client to re-send the wrapped request on the next turn."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["goto"],"x-enumNames":["GOTO"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"request":{"$ref":"BaseRequest"}},"required":["request"]} |
IntentRequest
Trigger a specific intent from your conversation model.
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
payload · required | {"$ref":"IntentRequestPayload"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
IntentRequestEntity
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
value · required | {"type":"string"} |
query | {"type":"string"} |
verboseValue | {"type":"array","items":{"$ref":"VerboseValue"}} |
IntentRequestPayload
{"type":"object"}
| Property | Definition |
|---|---|
actions | {"type":"array","items":{"$ref":"BaseAction"}} |
label | {"type":"string"} |
data | {"type":"object","additionalProperties":{}} |
query | {"default":"","type":"string"} |
intent · required | {"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":{}} |
entities | {"default":[],"type":"array","items":{"$ref":"IntentRequestEntity"}} |
confidence | {"type":"number"} |
KnowledgeBaseTrace
Reports a knowledge base retrieval: the chunks returned and the query that produced them.
{"type":"object","x-vf-doc":{"description":"Reports a knowledge base retrieval: the chunks returned and the query that produced them."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["knowledgeBase"],"x-enumNames":["KNOWLEDGE_BASE"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"chunks":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number"},"documentID":{"type":"string"},"documentData":{}},"required":["score","documentID","documentData"]}},"query":{"type":"object","properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"content":{"type":"string"}},"required":["role","content"]}},"output":{"nullable":true,"type":"string"}},"required":["messages","output"]}},"required":["chunks"]} |
LaunchRequest
Send a launch request to start a new conversation.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["launch"],"x-enumNames":["LAUNCH"]} |
payload | {"type":"object","properties":{"persona":{"type":"string"}},"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
LegacyIntentRequest
The legacy intent request type that general-runtime expects from its clients.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
payload · required | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"BaseAction"}},"label":{"type":"string"},"query":{"default":"","type":"string"},"intent":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":{}},"entities":{"default":[],"type":"array","items":{"$ref":"IntentRequestEntity"}},"confidence":{"type":"number"}},"required":["intent","entities"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
LiveAgentHandoffContinueConversationPayload / TestingRuntime_LiveAgentHandoffContinueConversationPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["continue_conversation"],"x-enumNames":["CONTINUE_CONVERSATION"]} |
LiveAgentHandoffFileUploadPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["file_upload"],"x-enumNames":["FILE_UPLOAD"]} |
files · required | {"minItems":1,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"},"status":{"type":"string","enum":["uploaded","failed"],"x-enumNames":["UPLOADED","FAILED"]},"metadata":{"type":"object","additionalProperties":{}}},"required":["id","name","size","type"]}} |
LiveAgentHandoffMessagePayload / TestingRuntime_LiveAgentHandoffMessagePayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["message"],"x-enumNames":["MESSAGE"]} |
message · required | {"type":"string"} |
LiveAgentHandoffProvider / TestingRuntime_LiveAgentHandoffProvider
{"type":"string","enum":["ujet","genesys","kustomer","dixa","sunshine","custom"],"x-enumNames":["UJET","GENESYS","KUSTOMER","DIXA","SUNSHINE","CUSTOM"]}
LiveAgentHandoffRequest
Sent to interact with a connected live agent.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["live-agent-handoff"],"x-enumNames":["LIVE_AGENT_HANDOFF"]} |
payload · required | {"oneOf":[{"$ref":"LiveAgentHandoffMessagePayload"},{"$ref":"LiveAgentHandoffFileUploadPayload"},{"$ref":"LiveAgentHandoffContinueConversationPayload"},{"$ref":"LiveAgentHandoffReturnToVoiceflowPayload"}]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
LiveAgentHandoffReturnToVoiceflowPayload / TestingRuntime_LiveAgentHandoffReturnToVoiceflowPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["return_to_voiceflow"],"x-enumNames":["RETURN_TO_VOICEFLOW"]} |
LiveAgentHandoffTrace
Signals a handoff of the conversation to a live agent platform. Every shape of the payload carries conversationID, message, and event; the remaining fields vary by shape, and some carry a provider naming the platform.
{"type":"object","x-vf-doc":{"description":"Signals a handoff of the conversation to a live agent platform. Every shape of the payload carries `conversationID`, `message`, and `event`; the remaining fields vary by shape, and some carry a `provider` naming the platform."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["live-agent-handoff"],"x-enumNames":["LIVE_AGENT_HANDOFF"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"type":"string","enum":["chat_started"],"x-enumNames":["CHAT_STARTED"]},"provider":{"allOf":[{"$ref":"LiveAgentHandoffProvider"}]},"config":{"allOf":[{"$ref":"LiveAgentHandoffWidgetConfig"}]}},"required":["conversationID","message","event"]},{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"anyOf":[{"type":"string","enum":["chat_ended"],"x-enumNames":["CHAT_ENDED"]},{"type":"string","enum":["chat_dismissed"],"x-enumNames":["CHAT_DISMISSED"]}]},"downloadMessage":{"type":"string"},"continueMessage":{"type":"string"},"newConversationMessage":{"type":"string"}},"required":["conversationID","message","event"]},{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"type":"string","enum":["file_received"],"x-enumNames":["FILE_RECEIVED"]},"file":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["url","name"]}},"required":["conversationID","message","event","file"]},{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"anyOf":[{"type":"string","enum":["participant_joined"],"x-enumNames":["PARTICIPANT_JOINED"]},{"type":"string","enum":["message_received"],"x-enumNames":["MESSAGE_RECEIVED"]},{"type":"string","enum":["event"],"x-enumNames":["EVENT"]},{"type":"string","enum":["wait_time"],"x-enumNames":["WAIT_TIME"]},{"type":"string","enum":["chat_dismissal_warning"],"x-enumNames":["CHAT_DISMISSAL_WARNING"]},{"type":"string","enum":["agent_typing"],"x-enumNames":["AGENT_TYPING"]}]}},"required":["conversationID","message","event"]}]} |
LiveAgentHandoffWidgetConfig / TestingRuntime_LiveAgentHandoffWidgetConfig
{"type":"object"}
| Property | Definition |
|---|---|
returnToAI | {"type":"boolean"} |
disableFileUpload | {"type":"boolean"} |
LogTrace
Diagnostic log output attached to the turn. The payload is always present and is a free-form object: the spec declares no named fields on it and permits any.
{"type":"object","x-vf-doc":{"description":"Diagnostic log output attached to the turn. The `payload` is always present and is a free-form object: the spec declares no named fields on it and permits any."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["log"],"x-enumNames":["LOG"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","additionalProperties":{}} |
MessageRequest
Similar to the text action.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["message"],"x-enumNames":["MESSAGE"]} |
payload · required | {"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
NoReplyRequest
Represents the user failing to reply, typically sent after a reasonable timeout.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["no-reply"],"x-enumNames":["NO_REPLY"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
NoReplyTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["no-reply"],"x-enumNames":["NO_REPLY"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"timeout":{"type":"number"}},"required":["timeout"]} |
PathRequest
Continue the conversation by traveling down the specified path.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
payload · required | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"BaseAction"}},"label":{"type":"string"}},"required":["label"],"additionalProperties":{}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
PathTrace
Reports which path the conversation took out of a step.
{"type":"object","x-vf-doc":{"description":"Reports which path the conversation took out of a step."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["path"],"x-enumNames":["PATH"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"path":{"type":"string"}},"required":["path"]} |
RealtimeAgentTrace
Marks realtime agent activity on the turn. The payload's action field selects the shape: START carries input and output, while END and INTERRUPTED carry the action alone.
{"type":"object","x-vf-doc":{"description":"Marks realtime agent activity on the turn. The payload's `action` field selects the shape: `START` carries `input` and `output`, while `END` and `INTERRUPTED` carry the action alone."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["realtime-agent"],"x-enumNames":["REALTIME_AGENT"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"oneOf":[{"type":"object","properties":{"action":{"type":"string","enum":["START"],"x-enumNames":["START"]},"input":{"type":"object","properties":{"encoding":{"$ref":"AudioEncoding"},"sampleRate":{"type":"number"}},"required":["encoding"]},"output":{"type":"object","properties":{"encoding":{"$ref":"AudioEncoding"},"sampleRate":{"type":"number"}},"required":["encoding"]}},"required":["action","input","output"]},{"type":"object","properties":{"action":{"type":"string","enum":["END"],"x-enumNames":["END"]}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","enum":["INTERRUPTED"],"x-enumNames":["INTERRUPTED"]}},"required":["action"]}]} |
ReasoningTrace
Marks model reasoning activity during the turn. The payload's state field selects the shape: content carries a content string, final carries a message, and start and end carry the state alone.
{"type":"object","x-vf-doc":{"description":"Marks model reasoning activity during the turn. The payload's `state` field selects the shape: `content` carries a `content` string, `final` carries a `message`, and `start` and `end` carry the state alone."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["reasoning"],"x-enumNames":["REASONING"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"oneOf":[{"type":"object","properties":{"state":{"type":"string","enum":["start"],"x-enumNames":["START"]}},"required":["state"]},{"type":"object","properties":{"state":{"type":"string","enum":["content"],"x-enumNames":["CONTENT"]},"content":{"type":"string"}},"required":["state","content"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]}},"required":["state"]},{"type":"object","properties":{"state":{"type":"string","enum":["final"],"x-enumNames":["FINAL"]},"message":{"type":"string"}},"required":["state","message"]}]} |
SpeakTrace
A spoken response for voice channels, carrying the message text and optionally a synthesized audio source and voice name.
{"type":"object","x-vf-doc":{"description":"A spoken response for voice channels, carrying the message text and optionally a synthesized audio source and voice name."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["speak"],"x-enumNames":["SPEAK"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ai":{"type":"boolean"},"message":{"type":"string"},"type":{"$ref":"TraceSpeakType"},"src":{"nullable":true,"type":"string"},"voice":{"type":"string"},"isPrompt":{"type":"boolean"}},"required":["message","type"]} |
StableConversationScriptButtonStep
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
type | {"type":"string","enum":["button"],"x-enumNames":["BUTTON"]} |
button · required | The label of a button the turn before offered, pressed the way the user would press it. {"type":"string","minLength":1,"maxLength":200} |
StableConversationScriptRequest
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
messages · required | The user messages to send, in order, after the launch. A message is typed text, as a string or { "text": "…" }, or a button press, as { "button": "<label>" }, for a button the reply before offered. The digest shows offered buttons as "[buttons: Yes | No]". {"minItems":1,"maxItems":10,"type":"array","items":{"anyOf":[{"type":"string","minLength":1,"maxLength":2000},{"$ref":"StableConversationScriptTextStep"},{"$ref":"StableConversationScriptButtonStep"}]}} |
variables | Variable values to set before the launch, keyed by variable name, to start as a known caller. Next to messages, not inside launch. {"type":"object","additionalProperties":{}} |
version | Whether to talk to the draft or the published version of the environment. Draft unless you pass it. {"default":"draft","type":"string","enum":["draft","published"],"x-enumNames":["DRAFT","PUBLISHED"]} |
launch | How the conversation starts; payload is its only field. Leave it out for a plain launch. {"type":"object","properties":{"payload":{"type":"object","properties":{"persona":{"type":"string"}},"additionalProperties":{},"description":"The launch payload, as a website passes it to the chat widget, for example { \"lang\": \"de\" }. The agent reads it from the last_event variable."}},"required":["payload"],"additionalProperties":false} |
userID | The conversation user ID to run as; the agent reads it as the user_id variable. Use it when the agent expects a caller ID of a known shape, such as a phone number, and make one up: never a real customer's ID. Draft version only. Leave it out to run as a new user each time. A reused ID keeps the variables an earlier conversation with it left. {"type":"string","minLength":1,"maxLength":128,"pattern":"^[\\w+.@:-]+$"} |
StableConversationScriptResponse
{"type":"object"}
| Property | Definition |
|---|---|
userID · required | The conversation user ID the script ran as, for reading its state afterwards. {"type":"string"} |
transcriptID · required | The transcript this conversation is saved to, for reading its logs. Null when the runtime reported none, for example when the project does not save test conversations; then search transcripts with sessionID set to userID. {"nullable":true,"type":"string"} |
needsRecompile · required | When true, the script ran against a stale prototype. Compile the environment and run it again; do not treat these turns as proof the latest edits work. {"type":"boolean"} |
turns · required | The launch turn first, then one turn per message sent. {"type":"array","items":{"$ref":"StableConversationScriptTurn"}} |
notSent · required | Steps that were not run, in the same form as user, because the conversation ended, a send failed, a button was not on offer, the runtime logged an error outside a tool or a fatal error, the credit limit was reached, or the caller stopped the script first. A failed tool or HTTP call does not stop the script: it is listed in its turn. {"type":"array","items":{"type":"string"}} |
StableConversationScriptTextStep
{"type":"object","additionalProperties":false}
| Property | Definition |
|---|---|
type | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
text · required | The message the user types. {"type":"string","minLength":1,"maxLength":2000} |
StableConversationScriptToolCall
{"type":"object"}
| Property | Definition |
|---|---|
name · required | The tool that ran: by the name the agent called it, or its own name when a workflow step ran it. {"type":"string"} |
arguments · required | The arguments the agent passed, as JSON, cut to 300 characters. {} when a workflow step ran the tool. {"type":"string"} |
StableConversationScriptTurn
{"type":"object"}
| Property | Definition |
|---|---|
user · required | The step run in this turn: the message sent, or "[button: <label>]" for a button press. Null for the launch turn that starts the conversation. {"nullable":true,"type":"string"} |
agent · required | The agent's replies in this turn, in order, at most 10, each cut to 1,000 characters. Buttons, cards and carousels come summarised, such as "[buttons: Yes | No]" or "[card: <title>]". {"type":"array","items":{"type":"string"}} |
repliedBy · required | Who gave this turn's replies, in order, at most 10: an agent by name, such as "Main Agent", a playbook as "<name> (playbook)", or "workflow <name>" for a workflow step. Empty when the traces name no one. A reply from someone you did not expect means the routing did not work. {"type":"array","items":{"type":"string"}} |
toolCalls · required | The tools the agent called and the tools its workflow steps ran in this turn, at most 20. {"type":"array","items":{"$ref":"StableConversationScriptToolCall"}} |
variableChanges · required | The variables this turn set, changed or cleared, at most 30. Leaves out the variables that change every turn (vf_now, vf_time, timestamp, vf_memory, last_utterance, last_response, last_event, intent_confidence, _memory_). The launch turn lists the preset variables and the variables the launch set, not the system variables or the starting values. {"type":"array","items":{"$ref":"StableConversationScriptVariableChange"}} |
errors · required | Errors, failed tool calls, HTTP failures and credit limits the runtime reported in this turn, at most 10, each cut to 300 characters. A failed tool carries the cause the runtime recorded, such as a missing input. {"type":"array","items":{"type":"string"}} |
warnings · required | Every warning the runtime logged in this turn that is not an error, such as a transfer it ignored because the playbook's condition was not met, each cut to 300 characters. Past 10, the last entry says how many more there were; read them in the transcript's logs at level warn. A turn also says here when the variables before it could not be read, so it lists no variable changes: at the launch, the variables a supplied userID had; later, the variables after the turn before. {"type":"array","items":{"type":"string"}} |
ended · required | True when the conversation ended in this turn. An End step ends the whole conversation, not only its workflow: nothing the user says after it is answered. {"type":"boolean"} |
endedBy · required | When ended is true, what ended the conversation: the End step with its step ID and workflow, and the reason the runtime gave. Null when the turn did not end. {"nullable":true,"type":"string"} |
StableConversationScriptVariableChange
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
before · required | The value before the turn, as JSON cut to 200 characters. Null when it was not set; a null value is the string "null". {"nullable":true,"type":"string"} |
after · required | The value after the turn, as JSON cut to 200 characters. Null when it is not set; a null value is the string "null". {"nullable":true,"type":"string"} |
StableConversationSendConfig
{"type":"object"}
| Property | Definition |
|---|---|
excludeTypes | Trace types to drop from the response. Opt-in — when omitted, every trace is returned. {"type":"array","items":{"$ref":"TraceType"}} |
StableConversationSendRequest
{"type":"object"}
| Property | Definition |
|---|---|
action · required | {"$ref":"AnyRequest"} |
version · required | Whether to run the conversation against the draft or published version of the environment. {"type":"string","enum":["draft","published"],"x-enumNames":["DRAFT","PUBLISHED"]} |
sessionID | The unique ID of the conversation session to continue. {"type":"string"} |
config | Options controlling how the response is shaped. {"allOf":[{"$ref":"StableConversationSendConfig"}]} |
StableConversationSendResponse
{"type":"object"}
| Property | Definition |
|---|---|
traces · required | {"type":"array","items":{"$ref":"AnyTrace"}} |
needsRecompile · required | When true, this turn ran against a stale prototype. Compile the environment and send again; do not treat these traces as proof the latest edits work. {"type":"boolean"} |
StreamTrace
An audio stream event. The payload carries the source in src, a token, and an action of LOOP, PLAY, PAUSE, or END; title, description, iconImage, backgroundImage, and loop are optional.
{"type":"object","x-vf-doc":{"description":"An audio stream event. The payload carries the source in `src`, a `token`, and an `action` of `LOOP`, `PLAY`, `PAUSE`, or `END`; `title`, `description`, `iconImage`, `backgroundImage`, and `loop` are optional."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["stream"],"x-enumNames":["STREAM"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"src":{"type":"string"},"token":{"type":"string"},"action":{"$ref":"TraceStreamAction"},"loop":{"type":"boolean"},"title":{"type":"string"},"iconImage":{"type":"string"},"description":{"type":"string"},"backgroundImage":{"type":"string"}},"required":["src","token","action"]} |
TestingRuntime_ActionRequest
Actions are self-describing operations with an associated payload.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["action"],"x-enumNames":["ACTION"]} |
payload | {"type":"object","additionalProperties":{},"properties":{"actions":{"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}},"label":{"type":"string"}}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_AlexaIntentRequest
Legacy intent request type that general-runtime expects Alexa to send
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
payload · required | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}},"label":{"type":"string"},"data":{"type":"object","additionalProperties":{}},"query":{"default":"","type":"string"},"intent":{"type":"object","additionalProperties":{},"properties":{"name":{"type":"string"}},"required":["name"]},"entities":{"type":"array","items":{"$ref":"TestingRuntime_IntentRequestEntity"},"default":[]},"confidence":{"type":"number"}},"required":["data","intent","entities"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_AnyRequest
{"anyOf":[{"$ref":"TestingRuntime_LaunchRequest"},{"$ref":"TestingRuntime_TextRequest"},{"$ref":"TestingRuntime_FileRequest"},{"$ref":"TestingRuntime_ActionRequest"},{"$ref":"TestingRuntime_IntentRequest"},{"$ref":"TestingRuntime_EventRequest"},{"$ref":"TestingRuntime_PathRequest"},{"$ref":"TestingRuntime_NoReplyRequest"},{"$ref":"TestingRuntime_MessageRequest"},{"$ref":"TestingRuntime_EndRequest"},{"$ref":"TestingRuntime_DTMFRequest"},{"$ref":"TestingRuntime_LiveAgentHandoffRequest"},{"$ref":"TestingRuntime_GeneralRequest"},{"$ref":"TestingRuntime_AlexaIntentRequest"},{"$ref":"TestingRuntime_LegacyIntentRequest"}]}
TestingRuntime_AnyTrace
{"oneOf":[{"$ref":"TestingRuntime_AudioTrace"},{"$ref":"TestingRuntime_SpeakTrace"},{"$ref":"TestingRuntime_StreamTrace"},{"$ref":"TestingRuntime_BlockTrace"},{"$ref":"TestingRuntime_CardTrace"},{"$ref":"TestingRuntime_CarouselTrace"},{"$ref":"TestingRuntime_ChannelActionTrace"},{"$ref":"TestingRuntime_ChoiceTrace"},{"$ref":"TestingRuntime_CompletionTrace"},{"$ref":"TestingRuntime_DebugTrace"},{"$ref":"TestingRuntime_DTMFTrace"},{"$ref":"TestingRuntime_EntityFillingTrace"},{"$ref":"TestingRuntime_ExitTrace"},{"$ref":"TestingRuntime_FlowTrace"},{"$ref":"TestingRuntime_GoToTrace"},{"$ref":"TestingRuntime_LogTrace"},{"$ref":"TestingRuntime_NoReplyTrace"},{"$ref":"TestingRuntime_PathTrace"},{"$ref":"TestingRuntime_TextTrace"},{"$ref":"TestingRuntime_ReasoningTrace"},{"$ref":"TestingRuntime_VisualTrace"},{"$ref":"TestingRuntime_KnowledgeBaseTrace"},{"$ref":"TestingRuntime_CallForwardTrace"},{"$ref":"TestingRuntime_RealtimeAgentTrace"},{"$ref":"TestingRuntime_LiveAgentHandoffTrace"},{"$ref":"TestingRuntime_ToolCallTrace"}]}
TestingRuntime_AudioTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["audio"],"x-enumNames":["AUDIO"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["start"],"x-enumNames":["START"]},"messageID":{"type":"string"},"delay":{"type":"number"}},"required":["state","messageID"]},{"type":"object","properties":{"state":{"type":"string","enum":["content"],"x-enumNames":["CONTENT"]},"content":{"type":"string"},"encoding":{"$ref":"TestingRuntime_AudioEncoding"},"duration":{"type":"number"}},"required":["state","content","encoding"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]}},"required":["state"]}]} |
TestingRuntime_BlockTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["block"],"x-enumNames":["BLOCK"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"blockID":{"type":"string"}},"required":["blockID"]} |
TestingRuntime_Button
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
request | {"allOf":[{"$ref":"TestingRuntime_BaseRequest"}]} |
TestingRuntime_CallForwardTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["call-forward"],"x-enumNames":["CALL_FORWARD"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"$ref":"TestingRuntime_CallForwardPhone"},{"$ref":"TestingRuntime_CallForwardSIP"}]} |
TestingRuntime_CardTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["cardV2"],"x-enumNames":["CARD_V_2"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"$ref":"TestingRuntime_CardTraceCard"} |
TestingRuntime_CardTraceCard
{"type":"object"}
| Property | Definition |
|---|---|
ref | {"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]} |
title · required | {"type":"string"} |
buttons · required | {"type":"array","items":{"$ref":"TestingRuntime_Button"}} |
imageUrl · required | {"type":"string","nullable":true} |
messageID | {"type":"string"} |
description · required | {"type":"object","properties":{"text":{"type":"string"},"slate":{"type":"array","items":{}}},"required":["text"]} |
TestingRuntime_CarouselTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["carousel"],"x-enumNames":["CAROUSEL"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ref":{"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]},"cards":{"type":"array","items":{"$ref":"TestingRuntime_TraceCarouselCard"}},"layout":{"$ref":"TestingRuntime_CarouselLayout"},"messageID":{"type":"string"}},"required":["cards","layout"]} |
TestingRuntime_ChannelActionTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["channel-action"],"x-enumNames":["CHANNEL_ACTION"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"name":{"type":"string"},"payload":{"type":"object","additionalProperties":{}}},"required":["name","payload"]} |
TestingRuntime_ChoiceTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["choice"],"x-enumNames":["CHOICE"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ref":{"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]},"buttons":{"type":"array","items":{"$ref":"TestingRuntime_Button"}},"messageID":{"type":"string"}},"required":["buttons"]} |
TestingRuntime_CompletionTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["completion"],"x-enumNames":["COMPLETION"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"state":{"type":"string","enum":["start"],"x-enumNames":["START"]},"ai":{"type":"boolean"},"sourceUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url"]}},"delay":{"type":"number"},"messageID":{"type":"string"},"ref":{"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]}},"required":["state","messageID"]},{"type":"object","properties":{"state":{"type":"string","enum":["content"],"x-enumNames":["CONTENT"]},"content":{"type":"string"},"messageID":{"type":"string"}},"required":["state","content"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]},"ref":{"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]},"sourceUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url"]}},"messageID":{"type":"string"}},"required":["state"]}]} |
TestingRuntime_DTMFRequest
Represents the result of a dial-tone input, used for phone calls.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["dtmf"],"x-enumNames":["DTMF"]} |
payload · required | {"type":"string"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_DTMFTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["dtmf"],"x-enumNames":["DTMF"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"$ref":"TestingRuntime_DTMFTracePayload"} |
TestingRuntime_DTMFTracePayload
{"type":"object"}
| Property | Definition |
|---|---|
enabled · required | Enables the new DTMF collection and configuration {"type":"boolean"} |
timeoutInSeconds · required | How long to wait before processing the DTMF input. Set to 0 to process only after a delimiter is provided. {"type":"number","maximum":10,"minimum":0} |
delimiter · required | Which key to use to end DTMF input. Defaults to '#' {"type":"array","items":{"$ref":"TestingRuntime_DTMFDelimiter"}} |
maxDigits · required | The maximum number of digits before we finish their input {"type":"number","maximum":20,"minimum":1} |
TestingRuntime_DebugTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["debug"],"x-enumNames":["DEBUG"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ref":{"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]},"type":{"type":"string"},"level":{"allOf":[{"$ref":"TestingRuntime_DebugTraceLevel"}]},"message":{"type":"string"},"context":{"type":"string"},"metadata":{"type":"object","additionalProperties":{}}},"required":["message"]} |
TestingRuntime_DebugTraceRef
{"oneOf":[{"$ref":"TestingRuntime_DebugTraceNodeRef"},{"$ref":"TestingRuntime_DebugTraceAgentRef"},{"$ref":"TestingRuntime_DebugTracePromptRef"},{"$ref":"TestingRuntime_DebugTraceAPIToolRef"},{"$ref":"TestingRuntime_DebugTraceFunctionRef"},{"$ref":"TestingRuntime_DebugTraceIntegrationToolRef"},{"$ref":"TestingRuntime_DebugTraceMcpIntegrationToolRef"}]}
TestingRuntime_EndRequest
Sent to indicate the conversation has been ended.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["end"],"x-enumNames":["END"]} |
payload | {"type":"object","additionalProperties":{},"properties":{"reason":{"type":"string"},"message":{"type":"string"}},"required":["reason"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_EntityFillingTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["entity-filling"],"x-enumNames":["ENTITY_FILLING"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"entityToFill":{"type":"string"},"intent":{"$ref":"TestingRuntime_IntentRequest"}},"required":["entityToFill","intent"]} |
TestingRuntime_EventRequest
Events are triggers with an associated payload.
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["event"],"x-enumNames":["EVENT"]} |
payload · required | {"$ref":"TestingRuntime_EventRequestPayload"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_EventRequestPayload
{"type":"object"}
| Property | Definition |
|---|---|
actions | {"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}} |
label | {"type":"string"} |
event · required | {"type":"object","additionalProperties":{},"properties":{"name":{"type":"string"}},"required":["name"]} |
TestingRuntime_ExitTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["end"],"x-enumNames":["END"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload | {} |
TestingRuntime_FileRequest
Send one or more file attachments, with an optional text message.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["file"],"x-enumNames":["FILE"]} |
payload · required | {"type":"object","additionalProperties":{},"properties":{"text":{"type":"string"},"files":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"mimeType":{"type":"string"},"filename":{"type":"string"},"size":{"type":"number"},"s3Key":{"type":"string"}},"required":["mimeType"],"additionalProperties":{}},"minItems":1}},"required":["files"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_FlowTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["flow"],"x-enumNames":["FLOW"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"name":{"type":"string"},"diagramID":{"type":"string"}},"required":["diagramID"]} |
TestingRuntime_GeneralRequest
Represents an non-system-defined action.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
payload | {"type":"object","additionalProperties":{},"properties":{"actions":{"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}},"label":{"type":"string"}}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_GoToTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["goto"],"x-enumNames":["GOTO"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"request":{"$ref":"TestingRuntime_BaseRequest"}},"required":["request"]} |
TestingRuntime_IntentRequest
Trigger a specific intent from your conversation model.
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
payload · required | {"$ref":"TestingRuntime_IntentRequestPayload"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_IntentRequestEntity
{"type":"object"}
| Property | Definition |
|---|---|
name · required | {"type":"string"} |
value · required | {"type":"string"} |
query | {"type":"string"} |
verboseValue | {"type":"array","items":{"$ref":"TestingRuntime_VerboseValue"}} |
TestingRuntime_IntentRequestPayload
{"type":"object"}
| Property | Definition |
|---|---|
actions | {"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}} |
label | {"type":"string"} |
data | {"type":"object","additionalProperties":{}} |
query | {"default":"","type":"string"} |
intent · required | {"type":"object","additionalProperties":{},"properties":{"name":{"type":"string"}},"required":["name"]} |
entities | {"type":"array","items":{"$ref":"TestingRuntime_IntentRequestEntity"},"default":[]} |
confidence | {"type":"number"} |
TestingRuntime_KnowledgeBaseTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["knowledgeBase"],"x-enumNames":["KNOWLEDGE_BASE"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"chunks":{"type":"array","items":{"type":"object","properties":{"score":{"type":"number"},"documentID":{"type":"string"},"documentData":{}},"required":["score","documentID","documentData"]}},"query":{"properties":{"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"content":{"type":"string"}},"required":["role","content"]}},"output":{"type":"string","nullable":true}},"required":["messages","output"],"type":"object"}},"required":["chunks"]} |
TestingRuntime_LaunchRequest
Send a launch request to start a new conversation.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["launch"],"x-enumNames":["LAUNCH"]} |
payload | {"type":"object","additionalProperties":{},"properties":{"persona":{"type":"string"}}} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_LegacyIntentRequest
The legacy intent request type that general-runtime expects from its clients.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["intent"],"x-enumNames":["INTENT"]} |
payload · required | {"type":"object","properties":{"actions":{"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}},"label":{"type":"string"},"query":{"default":"","type":"string"},"intent":{"type":"object","additionalProperties":{},"properties":{"name":{"type":"string"}},"required":["name"]},"entities":{"type":"array","items":{"$ref":"TestingRuntime_IntentRequestEntity"},"default":[]},"confidence":{"type":"number"}},"required":["intent","entities"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_LiveAgentHandoffFileUploadPayload
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["file_upload"],"x-enumNames":["FILE_UPLOAD"]} |
files · required | {"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1},"name":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"},"status":{"type":"string","enum":["uploaded","failed"],"x-enumNames":["UPLOADED","FAILED"]},"metadata":{"type":"object","additionalProperties":{}}},"required":["id","name","size","type"]},"minItems":1} |
TestingRuntime_LiveAgentHandoffRequest
Sent to interact with a connected live agent.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["live-agent-handoff"],"x-enumNames":["LIVE_AGENT_HANDOFF"]} |
payload · required | {"oneOf":[{"$ref":"TestingRuntime_LiveAgentHandoffMessagePayload"},{"$ref":"TestingRuntime_LiveAgentHandoffFileUploadPayload"},{"$ref":"TestingRuntime_LiveAgentHandoffContinueConversationPayload"},{"$ref":"TestingRuntime_LiveAgentHandoffReturnToVoiceflowPayload"}]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_LiveAgentHandoffTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["live-agent-handoff"],"x-enumNames":["LIVE_AGENT_HANDOFF"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"type":"string","enum":["chat_started"],"x-enumNames":["CHAT_STARTED"]},"provider":{"allOf":[{"$ref":"TestingRuntime_LiveAgentHandoffProvider"}]},"config":{"allOf":[{"$ref":"TestingRuntime_LiveAgentHandoffWidgetConfig"}]}},"required":["conversationID","message","event"]},{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"anyOf":[{"type":"string","enum":["chat_ended"],"x-enumNames":["CHAT_ENDED"]},{"type":"string","enum":["chat_dismissed"],"x-enumNames":["CHAT_DISMISSED"]}]},"downloadMessage":{"type":"string"},"continueMessage":{"type":"string"},"newConversationMessage":{"type":"string"}},"required":["conversationID","message","event"]},{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"type":"string","enum":["file_received"],"x-enumNames":["FILE_RECEIVED"]},"file":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["url","name"]}},"required":["conversationID","message","event","file"]},{"type":"object","properties":{"conversationID":{"type":"string","minLength":1},"message":{"type":"string"},"translationKey":{"type":"string"},"translationParams":{"type":"object","additionalProperties":{"type":"string"}},"agent":{"type":"object","properties":{"name":{"type":"string","minLength":1},"imageUrl":{"type":"string","format":"uri"}},"required":["name"]},"event":{"anyOf":[{"type":"string","enum":["participant_joined"],"x-enumNames":["PARTICIPANT_JOINED"]},{"type":"string","enum":["message_received"],"x-enumNames":["MESSAGE_RECEIVED"]},{"type":"string","enum":["event"],"x-enumNames":["EVENT"]},{"type":"string","enum":["wait_time"],"x-enumNames":["WAIT_TIME"]},{"type":"string","enum":["chat_dismissal_warning"],"x-enumNames":["CHAT_DISMISSAL_WARNING"]},{"type":"string","enum":["agent_typing"],"x-enumNames":["AGENT_TYPING"]}]}},"required":["conversationID","message","event"]}]} |
TestingRuntime_LogTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["log"],"x-enumNames":["LOG"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","additionalProperties":{}} |
TestingRuntime_MessageRequest
Similar to the text action.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["message"],"x-enumNames":["MESSAGE"]} |
payload · required | {"type":"object","additionalProperties":{},"properties":{"message":{"type":"string"}},"required":["message"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_NoReplyRequest
Represents the user failing to reply, typically sent after a reasonable timeout.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["no-reply"],"x-enumNames":["NO_REPLY"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_NoReplyTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["no-reply"],"x-enumNames":["NO_REPLY"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"timeout":{"type":"number"}},"required":["timeout"]} |
TestingRuntime_PathRequest
Continue the conversation by traveling down the specified path.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string"} |
payload · required | {"type":"object","additionalProperties":{},"properties":{"actions":{"type":"array","items":{"$ref":"TestingRuntime_BaseAction"}},"label":{"type":"string"}},"required":["label"]} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","additionalProperties":{}} |
TestingRuntime_PathTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["path"],"x-enumNames":["PATH"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"path":{"type":"string"}},"required":["path"]} |
TestingRuntime_RealtimeAgentTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["realtime-agent"],"x-enumNames":["REALTIME_AGENT"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"oneOf":[{"type":"object","properties":{"action":{"type":"string","enum":["START"],"x-enumNames":["START"]},"input":{"type":"object","properties":{"encoding":{"$ref":"TestingRuntime_AudioEncoding"},"sampleRate":{"type":"number"}},"required":["encoding"]},"output":{"type":"object","properties":{"encoding":{"$ref":"TestingRuntime_AudioEncoding"},"sampleRate":{"type":"number"}},"required":["encoding"]}},"required":["action","input","output"]},{"type":"object","properties":{"action":{"type":"string","enum":["END"],"x-enumNames":["END"]}},"required":["action"]},{"type":"object","properties":{"action":{"type":"string","enum":["INTERRUPTED"],"x-enumNames":["INTERRUPTED"]}},"required":["action"]}]} |
TestingRuntime_ReasoningTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["reasoning"],"x-enumNames":["REASONING"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"oneOf":[{"type":"object","properties":{"state":{"type":"string","enum":["start"],"x-enumNames":["START"]}},"required":["state"]},{"type":"object","properties":{"state":{"type":"string","enum":["content"],"x-enumNames":["CONTENT"]},"content":{"type":"string"}},"required":["state","content"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]}},"required":["state"]},{"type":"object","properties":{"state":{"type":"string","enum":["final"],"x-enumNames":["FINAL"]},"message":{"type":"string"}},"required":["state","message"]}]} |
TestingRuntime_SpeakTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["speak"],"x-enumNames":["SPEAK"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ai":{"type":"boolean"},"message":{"type":"string"},"type":{"$ref":"TestingRuntime_TraceSpeakType"},"src":{"type":"string","nullable":true},"voice":{"type":"string"},"isPrompt":{"type":"boolean"}},"required":["message","type"]} |
TestingRuntime_StreamTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["stream"],"x-enumNames":["STREAM"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"src":{"type":"string"},"token":{"type":"string"},"action":{"$ref":"TestingRuntime_TraceStreamAction"},"loop":{"type":"boolean"},"title":{"type":"string"},"iconImage":{"type":"string"},"description":{"type":"string"},"backgroundImage":{"type":"string"}},"required":["src","token","action"]} |
TestingRuntime_TextRequest
Send the user response as a raw text payload.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
payload · required | {"type":"string"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","properties":{"source":{"type":"string"}}} |
TestingRuntime_TextTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ai":{"type":"boolean"},"message":{"type":"string"},"ref":{"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]},"slate":{"type":"object","properties":{"id":{"type":"string"},"content":{"items":{},"type":"array"}},"required":["id","content"]},"delay":{"type":"number"},"voice":{"type":"string"},"audio":{"type":"object","properties":{"src":{"type":"string"}},"required":["src"]},"messageID":{"type":"string"},"sourceUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url"]}}},"required":["message","slate","messageID"]} |
TestingRuntime_ToolCallTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["tool-call"],"x-enumNames":["TOOL_CALL"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"callID":{"type":"string"},"sound":{"type":"object","properties":{"ref":{"type":"string"},"volume":{"type":"number","maximum":1,"minimum":0}},"required":["ref"]},"state":{"type":"string","enum":["start"],"x-enumNames":["START"]}},"required":["callID","state"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]},"callID":{"type":"string"}},"required":["state","callID"]}]} |
TestingRuntime_TraceCarouselCard
{"type":"object"}
| Property | Definition |
|---|---|
ref | {"allOf":[{"$ref":"TestingRuntime_DebugTraceRef"}]} |
title · required | {"type":"string"} |
buttons · required | {"type":"array","items":{"$ref":"TestingRuntime_Button"}} |
imageUrl · required | {"type":"string","nullable":true} |
messageID | {"type":"string"} |
description · required | {"type":"object","properties":{"text":{"type":"string"},"slate":{"type":"array","items":{}}},"required":["text"]} |
id | {"type":"string"} |
TestingRuntime_TracePath
{"type":"object"}
| Property | Definition |
|---|---|
label | {"type":"string"} |
event | {"allOf":[{"$ref":"TestingRuntime_BaseRequest"}]} |
TestingRuntime_TraceSpeakType / TraceSpeakType
{"type":"string","enum":["audio","message"],"x-enumNames":["AUDIO","MESSAGE"]}
TestingRuntime_TraceStreamAction / TraceStreamAction
{"type":"string","enum":["LOOP","PLAY","PAUSE","END"],"x-enumNames":["LOOP","PLAY","PAUSE","END"]}
TestingRuntime_TraceType / TraceType
{"type":"string","enum":["log","end","text","path","flow","goto","speak","block","debug","choice","stream","visual","cardV2","carousel","no-reply","reasoning","completion","audio","call-forward","live-agent-handoff","entity-filling","channel-action","knowledgeBase","realtime-agent","dtmf","tool-call","simulation-test-result"],"x-enumNames":["LOG","END","TEXT","PATH","FLOW","GOTO","SPEAK","BLOCK","DEBUG","CHOICE","STREAM","VISUAL","CARD_V_2","CAROUSEL","NO_REPLY","REASONING","COMPLETION","AUDIO","CALL_FORWARD","LIVE_AGENT_HANDOFF","ENTITY_FILLING","CHANNEL_ACTION","KNOWLEDGE_BASE","REALTIME_AGENT","DTMF","TOOL_CALL","SIMULATION_TEST_RESULT"]}
TestingRuntime_VerboseValue / VerboseValue
{"type":"object"}
| Property | Definition |
|---|---|
rawText · required | {"type":"string"} |
canonicalText · required | {"type":"string"} |
startIndex · required | {"type":"number"} |
TestingRuntime_VisualTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["visual"],"x-enumNames":["VISUAL"]} |
paths | {"type":"array","items":{"$ref":"TestingRuntime_TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"$ref":"TestingRuntime_VisualTraceImage"} |
TestingRuntime_VisualTraceImage
{"type":"object"}
| Property | Definition |
|---|---|
visualType | {"type":"string","enum":["image"],"x-enumNames":["IMAGE"]} |
image · required | {"type":"string","nullable":true} |
device | {"type":"string","nullable":true} |
options | {"type":"object","properties":{"loop":{"type":"boolean"}}} |
frameType | {"type":"string"} |
dimensions | {"type":"object","nullable":true,"properties":{"width":{"type":"number"},"height":{"type":"number"}},"required":["width","height"]} |
canvasVisibility | {"allOf":[{"$ref":"TestingRuntime_CanvasVisibility"}]} |
TextRequest
Send the user response as a raw text payload.
{"type":"object","additionalProperties":{}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
payload · required | {"type":"string"} |
diagramID | {"type":"string"} |
time | {"type":"number"} |
metadata | {"type":"object","properties":{"source":{"type":"string"}}} |
TextTrace
{"type":"object"}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["text"],"x-enumNames":["TEXT"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"type":"object","properties":{"ai":{"type":"boolean"},"message":{"type":"string"},"ref":{"allOf":[{"$ref":"DebugTraceRef"}]},"slate":{"type":"object","properties":{"id":{"type":"string"},"content":{"type":"array","items":{}}},"required":["id","content"]},"delay":{"type":"number"},"voice":{"type":"string"},"audio":{"type":"object","properties":{"src":{"type":"string"}},"required":["src"]},"messageID":{"type":"string"},"sourceUrls":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"name":{"type":"string"}},"required":["url"]}}},"required":["message","slate","messageID"]} |
ToolCallTrace
Marks a tool call made by the agent during the turn. The payload always carries the callID and a state of start or end; a start may also carry a sound.
{"type":"object","x-vf-doc":{"description":"Marks a tool call made by the agent during the turn. The payload always carries the `callID` and a `state` of `start` or `end`; a `start` may also carry a `sound`."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["tool-call"],"x-enumNames":["TOOL_CALL"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"anyOf":[{"type":"object","properties":{"callID":{"type":"string"},"sound":{"type":"object","properties":{"ref":{"type":"string"},"volume":{"type":"number","minimum":0,"maximum":1}},"required":["ref"]},"state":{"type":"string","enum":["start"],"x-enumNames":["START"]}},"required":["callID","state"]},{"type":"object","properties":{"state":{"type":"string","enum":["end"],"x-enumNames":["END"]},"callID":{"type":"string"}},"required":["state","callID"]}]} |
TraceCarouselCard
{"type":"object"}
| Property | Definition |
|---|---|
ref | {"allOf":[{"$ref":"DebugTraceRef"}]} |
title · required | {"type":"string"} |
buttons · required | {"type":"array","items":{"$ref":"Button"}} |
imageUrl · required | {"nullable":true,"type":"string"} |
messageID | {"type":"string"} |
description · required | {"type":"object","properties":{"text":{"type":"string"},"slate":{"type":"array","items":{}}},"required":["text"]} |
id | {"type":"string"} |
TracePath
{"type":"object"}
| Property | Definition |
|---|---|
label | {"type":"string"} |
event | {"allOf":[{"$ref":"BaseRequest"}]} |
VisualTrace
Displays an image, with optional device sizing and layout options.
{"type":"object","x-vf-doc":{"description":"Displays an image, with optional device sizing and layout options."}}
| Property | Definition |
|---|---|
type · required | {"type":"string","enum":["visual"],"x-enumNames":["VISUAL"]} |
paths | {"type":"array","items":{"$ref":"TracePath"}} |
defaultPath | {"type":"number"} |
time | {"type":"number"} |
turnID | {"type":"string"} |
handleID | {"type":"string"} |
payload · required | {"$ref":"VisualTraceImage"} |
VisualTraceImage
{"type":"object"}
| Property | Definition |
|---|---|
visualType | {"type":"string","enum":["image"],"x-enumNames":["IMAGE"]} |
image · required | {"nullable":true,"type":"string"} |
device | {"nullable":true,"type":"string"} |
options | {"type":"object","properties":{"loop":{"type":"boolean"}}} |
frameType | {"type":"string"} |
dimensions | {"nullable":true,"type":"object","properties":{"width":{"type":"number"},"height":{"type":"number"}},"required":["width","height"]} |
canvasVisibility | {"allOf":[{"$ref":"CanvasVisibility"}]} |
Was this page helpful?
Thanks for your feedback.