> ## Documentation Index
> Fetch the complete documentation index at: https://www.voiceflow.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Test your agent

Send a single test action, run a multi-turn test script, or test an existing REST integration. Launch starts a conversation; text continues it.

API version: Selected per operation

## Send a test turn

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.

### Endpoint

```http
PUT /v1/stable/conversation/{userID}
```

Server: https://realtime-api.voiceflow.com

### Launch request

Start a conversation by sending a launch action to this endpoint. Launch is a request type, not a separate route.

```json
{
  "action": {
    "type": "launch"
  },
  "version": "draft"
}
```

### Text request

Send a user message to continue the conversation. Use the same user ID or session as the launch request.

```json
{
  "action": {
    "type": "text",
    "payload": "Where is my order?"
  },
  "version": "draft"
}
```

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Path parameters

#### `userID`

Required · string

The ID identifying this conversation. Any stable string you choose; the same value addresses the same conversation on every call.

```json
{
  "type": "string"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableConversationSendRequest"
      }
    }
  }
}
```

### Responses

#### 200

Returns 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.

Schema:

```json
{
  "$ref": "#/components/schemas/StableConversationSendResponse"
}
```

Example:

```json
{
  "traces": [
    {
      "type": "audio",
      "paths": [
        "<TracePath>"
      ],
      "defaultPath": 0,
      "time": 0,
      "turnID": "<string>",
      "handleID": "<string>",
      "payload": {
        "state": "start",
        "messageID": "<string>",
        "delay": 0
      }
    }
  ],
  "needsRecompile": true
}
```

### Request examples

#### cURL

```bash
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>"
    ]
  }
}'
```

#### JavaScript

```javascript
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();
```

#### Python

```python
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()
```

#### Voiceflow CLI

```bash
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
```


## Run a test script

Test a short conversation in one request. The script launches the agent automatically, then sends your messages in order and returns the results.

### Endpoint

```http
POST /v1/stable/conversation/script
```

Server: https://realtime-api.voiceflow.com

### Authentication

```json
[
  {
    "token": []
  }
]
```

`token`:

```json
{
  "scheme": "bearer",
  "bearerFormat": "JWT",
  "type": "http",
  "description": "Voiceflow bearer token"
}
```

### Query parameters

#### `projectID`

Required · string

The ID of the project to operate on.

```json
{
  "type": "string",
  "description": "The ID of the project to operate on."
}
```

#### `environmentAlias`

Required · string

The alias of the environment to operate on (e.g. `main`).

```json
{
  "type": "string",
  "description": "The alias of the environment to operate on (e.g. `main`)."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/StableConversationScriptRequest"
      }
    }
  }
}
```

### Responses

#### 200

Returns 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.

Schema:

```json
{
  "$ref": "#/components/schemas/StableConversationScriptResponse"
}
```

Example:

```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>"
  ]
}
```

### Request examples

#### cURL

```bash
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>"
}'
```

#### JavaScript

```javascript
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();
```

#### Python

```python
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()
```

#### Voiceflow CLI

```bash
vf conversation run-script --project-id <projectID> --environment-alias <environmentAlias> <<'JSON'
{
  "messages": [
    "<string>"
  ],
  "variables": {},
  "version": "draft",
  "launch": {
    "payload": {
      "persona": "<string>"
    }
  },
  "userID": "<string>"
}
JSON
```


## Interact (REST)

Send 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.

### Endpoint

```http
POST /v4/interact
```

Server: https://general-runtime.voiceflow.com

### Session required

Start a [conversation session](/docs/api-reference/v4interact/start-session-specific-environment), then authorize this REST request with the returned session key. Use [Chat agents](/docs/api-reference/agent-runtime/chat) or [Voice agents](/docs/api-reference/agent-runtime/voice) for customer-facing integrations.

### Launch request

Start a conversation by sending a launch action to this endpoint. Launch is a request type, not a separate route.

```json
{
  "action": {
    "type": "launch"
  }
}
```

### Text request

Send a user message to continue the conversation. Use the same user ID or session as the launch request.

```json
{
  "action": {
    "type": "text",
    "payload": "Where is my order?"
  }
}
```

### Authentication

```json
[
  {
    "TestingRuntime_session": []
  }
]
```

`TestingRuntime_session`:

```json
{
  "type": "apiKey",
  "in": "header",
  "name": "authorization",
  "description": "Session key returned from the start session endpoint."
}
```

### Request body

Required

```json
{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "action": {
            "description": "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.",
            "allOf": [
              {
                "$ref": "#/components/schemas/TestingRuntime_AnyRequest"
              }
            ]
          },
          "variables": {
            "description": "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](/docs/documentation/build/data/variables).",
            "type": "object",
            "additionalProperties": {}
          },
          "state": {},
          "config": {
            "description": "Optional settings for this turn.",
            "type": "object",
            "default": {},
            "properties": {
              "userTimezone": {
                "description": "The user's IANA timezone string (eg: `America/New_York`). Sets `{vf_user_timezone}` variable. Used to localize time-dependent agent behavior.",
                "type": "string"
              },
              "excludeTypes": {
                "description": "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.",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/TestingRuntime_TraceType"
                }
              }
            }
          }
        },
        "required": [
          "action"
        ]
      }
    }
  }
}
```

### Responses

#### 200

Schema:

```json
{
  "type": "object",
  "properties": {
    "traces": {
      "description": "An array of [traces](/docs/api-reference/trace-types) that occurred during this turn.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_AnyTrace"
      }
    }
  },
  "required": [
    "traces"
  ]
}
```

Example:

```json
{
  "traces": [
    {
      "type": "audio",
      "paths": [
        "<TestingRuntime_TracePath>"
      ],
      "defaultPath": 0,
      "time": 0,
      "turnID": "<string>",
      "handleID": "<string>",
      "payload": {
        "state": "start",
        "messageID": "<string>",
        "delay": 0
      }
    }
  ]
}
```

#### 402

Returned 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.

Schema:

```json
{
  "type": "object",
  "properties": {
    "traces": {
      "description": "An array of [traces](/docs/api-reference/trace-types) that occurred during this turn.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_AnyTrace"
      }
    }
  },
  "required": [
    "traces"
  ]
}
```

Example:

```json
{
  "traces": [
    {
      "type": "audio",
      "paths": [
        "<TestingRuntime_TracePath>"
      ],
      "defaultPath": 0,
      "time": 0,
      "turnID": "<string>",
      "handleID": "<string>",
      "payload": {
        "state": "start",
        "messageID": "<string>",
        "delay": 0
      }
    }
  ]
}
```

### Request examples

#### cURL

```bash
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"
    ]
  }
}'
```

#### JavaScript

```javascript
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();
```

#### Python

```python
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()
```


## Schema definitions

### ActionRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "action"
      ],
      "x-enumNames": [
        "ACTION"
      ]
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/BaseAction"
          }
        },
        "label": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": {},
  "description": "Actions are self-describing operations with an associated payload."
}
```

### AlexaIntentRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "intent"
      ],
      "x-enumNames": [
        "INTENT"
      ]
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/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": "#/components/schemas/IntentRequestEntity"
          }
        },
        "confidence": {
          "type": "number"
        }
      },
      "required": [
        "data",
        "intent",
        "entities"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Legacy intent request type that `general-runtime` expects Alexa to send"
}
```

### AnyRequest

```json
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/LaunchRequest"
    },
    {
      "$ref": "#/components/schemas/TextRequest"
    },
    {
      "$ref": "#/components/schemas/FileRequest"
    },
    {
      "$ref": "#/components/schemas/ActionRequest"
    },
    {
      "$ref": "#/components/schemas/IntentRequest"
    },
    {
      "$ref": "#/components/schemas/EventRequest"
    },
    {
      "$ref": "#/components/schemas/PathRequest"
    },
    {
      "$ref": "#/components/schemas/NoReplyRequest"
    },
    {
      "$ref": "#/components/schemas/MessageRequest"
    },
    {
      "$ref": "#/components/schemas/EndRequest"
    },
    {
      "$ref": "#/components/schemas/DTMFRequest"
    },
    {
      "$ref": "#/components/schemas/LiveAgentHandoffRequest"
    },
    {
      "$ref": "#/components/schemas/GeneralRequest"
    },
    {
      "$ref": "#/components/schemas/AlexaIntentRequest"
    },
    {
      "$ref": "#/components/schemas/LegacyIntentRequest"
    }
  ]
}
```

### AnyTrace

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/AudioTrace"
    },
    {
      "$ref": "#/components/schemas/SpeakTrace"
    },
    {
      "$ref": "#/components/schemas/StreamTrace"
    },
    {
      "$ref": "#/components/schemas/BlockTrace"
    },
    {
      "$ref": "#/components/schemas/CardTrace"
    },
    {
      "$ref": "#/components/schemas/CarouselTrace"
    },
    {
      "$ref": "#/components/schemas/ChannelActionTrace"
    },
    {
      "$ref": "#/components/schemas/ChoiceTrace"
    },
    {
      "$ref": "#/components/schemas/CompletionTrace"
    },
    {
      "$ref": "#/components/schemas/DebugTrace"
    },
    {
      "$ref": "#/components/schemas/DTMFTrace"
    },
    {
      "$ref": "#/components/schemas/EntityFillingTrace"
    },
    {
      "$ref": "#/components/schemas/ExitTrace"
    },
    {
      "$ref": "#/components/schemas/FlowTrace"
    },
    {
      "$ref": "#/components/schemas/GoToTrace"
    },
    {
      "$ref": "#/components/schemas/LogTrace"
    },
    {
      "$ref": "#/components/schemas/NoReplyTrace"
    },
    {
      "$ref": "#/components/schemas/PathTrace"
    },
    {
      "$ref": "#/components/schemas/TextTrace"
    },
    {
      "$ref": "#/components/schemas/ReasoningTrace"
    },
    {
      "$ref": "#/components/schemas/VisualTrace"
    },
    {
      "$ref": "#/components/schemas/KnowledgeBaseTrace"
    },
    {
      "$ref": "#/components/schemas/CallForwardTrace"
    },
    {
      "$ref": "#/components/schemas/RealtimeAgentTrace"
    },
    {
      "$ref": "#/components/schemas/LiveAgentHandoffTrace"
    },
    {
      "$ref": "#/components/schemas/ToolCallTrace"
    }
  ]
}
```

### AudioEncoding

```json
{
  "type": "string",
  "enum": [
    "audio/mp3",
    "audio/x-mulaw",
    "audio/pcm"
  ],
  "x-enumNames": [
    "MP_3",
    "MULAW",
    "PCM"
  ]
}
```

### AudioTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "audio"
      ],
      "x-enumNames": [
        "AUDIO"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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": "#/components/schemas/AudioEncoding"
            },
            "duration": {
              "type": "number"
            }
          },
          "required": [
            "state",
            "content",
            "encoding"
          ]
        },
        {
          "type": "object",
          "properties": {
            "state": {
              "type": "string",
              "enum": [
                "end"
              ],
              "x-enumNames": [
                "END"
              ]
            }
          },
          "required": [
            "state"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### BaseAction

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {}
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### BaseRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {},
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type"
  ]
}
```

### BlockTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "block"
      ],
      "x-enumNames": [
        "BLOCK"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "blockID": {
          "type": "string"
        }
      },
      "required": [
        "blockID"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Marks the conversation entering a block, identified by its block ID."
  },
  "description": "Marks the conversation entering a block, identified by its block ID."
}
```

### Button

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "request": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BaseRequest"
        }
      ]
    }
  },
  "required": [
    "name"
  ]
}
```

### CallForwardPhone

```json
{
  "type": "object",
  "properties": {
    "addressType": {
      "type": "string",
      "enum": [
        "phone"
      ],
      "x-enumNames": [
        "PHONE"
      ]
    },
    "address": {
      "type": "string"
    },
    "extension": {
      "type": "string"
    },
    "callerIDPassthrough": {
      "type": "boolean"
    }
  },
  "required": [
    "addressType",
    "address"
  ]
}
```

### CallForwardSIP

```json
{
  "type": "object",
  "properties": {
    "addressType": {
      "type": "string",
      "enum": [
        "sip"
      ],
      "x-enumNames": [
        "SIP"
      ]
    },
    "address": {
      "type": "string"
    }
  },
  "required": [
    "addressType",
    "address"
  ]
}
```

### CallForwardTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "call-forward"
      ],
      "x-enumNames": [
        "CALL_FORWARD"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/CallForwardPhone"
        },
        {
          "$ref": "#/components/schemas/CallForwardSIP"
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### CanvasVisibility

```json
{
  "type": "string",
  "enum": [
    "full",
    "hidden",
    "cropped"
  ],
  "x-enumNames": [
    "FULL",
    "HIDDEN",
    "CROPPED"
  ]
}
```

### CardTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "cardV2"
      ],
      "x-enumNames": [
        "CARD_V_2"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "$ref": "#/components/schemas/CardTraceCard"
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### CardTraceCard

```json
{
  "type": "object",
  "properties": {
    "ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DebugTraceRef"
        }
      ]
    },
    "title": {
      "type": "string"
    },
    "buttons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Button"
      }
    },
    "imageUrl": {
      "nullable": true,
      "type": "string"
    },
    "messageID": {
      "type": "string"
    },
    "description": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "slate": {
          "type": "array",
          "items": {}
        }
      },
      "required": [
        "text"
      ]
    }
  },
  "required": [
    "title",
    "buttons",
    "imageUrl",
    "description"
  ]
}
```

### CarouselLayout

```json
{
  "type": "string",
  "enum": [
    "List",
    "Carousel"
  ],
  "x-enumNames": [
    "LIST",
    "CAROUSEL"
  ]
}
```

### CarouselTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "carousel"
      ],
      "x-enumNames": [
        "CAROUSEL"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/DebugTraceRef"
            }
          ]
        },
        "cards": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TraceCarouselCard"
          }
        },
        "layout": {
          "$ref": "#/components/schemas/CarouselLayout"
        },
        "messageID": {
          "type": "string"
        }
      },
      "required": [
        "cards",
        "layout"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### ChannelActionTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "channel-action"
      ],
      "x-enumNames": [
        "CHANNEL_ACTION"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "payload": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "name",
        "payload"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "A channel-specific action, named by the channel integration, with an action-defined payload."
  },
  "description": "A channel-specific action, named by the channel integration, with an action-defined payload."
}
```

### ChoiceTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "choice"
      ],
      "x-enumNames": [
        "CHOICE"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/DebugTraceRef"
            }
          ]
        },
        "buttons": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Button"
          }
        },
        "messageID": {
          "type": "string"
        }
      },
      "required": [
        "buttons"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### CompletionTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "completion"
      ],
      "x-enumNames": [
        "COMPLETION"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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": "#/components/schemas/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": "#/components/schemas/DebugTraceRef"
                }
              ]
            },
            "sourceUrls": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "url"
                ]
              }
            },
            "messageID": {
              "type": "string"
            }
          },
          "required": [
            "state"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Marks a model completion event during the turn. Streaming clients receive the completion lifecycle described under completion event traces."
  },
  "description": "Marks a model completion event during the turn. Streaming clients receive the completion lifecycle described under completion event traces."
}
```

### DTMFDelimiter

```json
{
  "type": "string",
  "enum": [
    "#",
    "*"
  ],
  "x-enumNames": [
    "#",
    "*"
  ]
}
```

### DTMFRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "dtmf"
      ],
      "x-enumNames": [
        "DTMF"
      ]
    },
    "payload": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Represents the result of a dial-tone input, used for phone calls."
}
```

### DTMFTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "dtmf"
      ],
      "x-enumNames": [
        "DTMF"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "$ref": "#/components/schemas/DTMFTracePayload"
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "description": "Configures keypad (DTMF) input collection on a call: whether it is enabled, the timeout, the ending delimiter, and the digit cap."
}
```

### DTMFTracePayload

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "description": "Enables the new DTMF collection and configuration"
    },
    "timeoutInSeconds": {
      "type": "number",
      "minimum": 0,
      "maximum": 10,
      "description": "How long to wait before processing the DTMF input. Set to 0 to process only after a delimiter is provided."
    },
    "delimiter": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DTMFDelimiter"
      },
      "description": "Which key to use to end DTMF input. Defaults to '#'"
    },
    "maxDigits": {
      "type": "number",
      "minimum": 1,
      "maximum": 20,
      "description": "The maximum number of digits before we finish their input"
    }
  },
  "required": [
    "enabled",
    "timeoutInSeconds",
    "delimiter",
    "maxDigits"
  ]
}
```

### DebugTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "debug"
      ],
      "x-enumNames": [
        "DEBUG"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/DebugTraceRef"
            }
          ]
        },
        "type": {
          "type": "string"
        },
        "level": {
          "allOf": [
            {
              "$ref": "#/components/schemas/DebugTraceLevel"
            }
          ]
        },
        "message": {
          "type": "string"
        },
        "context": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "message"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "description": "Debug output for the turn, with a message and optional level, context, and metadata. Surfaced in agent logs rather than to end users."
}
```

### DebugTraceAPIToolRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "api-tool"
      ],
      "x-enumNames": [
        "API_TOOL"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "apiToolID": {
      "type": "string"
    },
    "apiToolName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "apiToolID"
  ]
}
```

### DebugTraceAgentRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "agent"
      ],
      "x-enumNames": [
        "AGENT"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "agentID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "agentName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "agentID",
    "diagramID"
  ]
}
```

### DebugTraceFunctionRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "function"
      ],
      "x-enumNames": [
        "FUNCTION"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "functionID": {
      "type": "string"
    },
    "functionName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "functionID"
  ]
}
```

### DebugTraceIntegrationToolRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "integration-tool"
      ],
      "x-enumNames": [
        "INTEGRATION_TOOL"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    },
    "integrationToolName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "integrationToolName"
  ]
}
```

### DebugTraceLevel

```json
{
  "type": "string",
  "enum": [
    "fatal",
    "error",
    "warn",
    "info",
    "debug"
  ],
  "x-enumNames": [
    "FATAL",
    "ERROR",
    "WARN",
    "INFO",
    "DEBUG"
  ]
}
```

### DebugTraceMcpIntegrationToolRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "mcp-integration-tool"
      ],
      "x-enumNames": [
        "MCP_INTEGRATION_TOOL"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "mcpToolName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "mcpToolName"
  ]
}
```

### DebugTraceNodeRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "node"
      ],
      "x-enumNames": [
        "NODE"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "nodeType": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "nodeType",
    "diagramID"
  ]
}
```

### DebugTracePromptRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "prompt"
      ],
      "x-enumNames": [
        "PROMPT"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "promptID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "promptID",
    "diagramID"
  ]
}
```

### DebugTraceRef

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/DebugTraceNodeRef"
    },
    {
      "$ref": "#/components/schemas/DebugTraceAgentRef"
    },
    {
      "$ref": "#/components/schemas/DebugTracePromptRef"
    },
    {
      "$ref": "#/components/schemas/DebugTraceAPIToolRef"
    },
    {
      "$ref": "#/components/schemas/DebugTraceFunctionRef"
    },
    {
      "$ref": "#/components/schemas/DebugTraceIntegrationToolRef"
    },
    {
      "$ref": "#/components/schemas/DebugTraceMcpIntegrationToolRef"
    }
  ]
}
```

### EndRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "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": {}
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": {},
  "description": "Sent to indicate the conversation has been ended."
}
```

### EntityFillingTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "entity-filling"
      ],
      "x-enumNames": [
        "ENTITY_FILLING"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "entityToFill": {
          "type": "string"
        },
        "intent": {
          "$ref": "#/components/schemas/IntentRequest"
        }
      },
      "required": [
        "entityToFill",
        "intent"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Requests a value for a named entity, wrapping the intent request being filled."
  },
  "description": "Requests a value for a named entity, wrapping the intent request being filled."
}
```

### EventRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "event"
      ],
      "x-enumNames": [
        "EVENT"
      ]
    },
    "payload": {
      "$ref": "#/components/schemas/EventRequestPayload"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "description": "Events are triggers with an associated payload."
}
```

### EventRequestPayload

```json
{
  "type": "object",
  "properties": {
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/BaseAction"
      }
    },
    "label": {
      "type": "string"
    },
    "event": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ],
      "additionalProperties": {}
    }
  },
  "required": [
    "event"
  ]
}
```

### ExitTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "end"
      ],
      "x-enumNames": [
        "END"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {}
  },
  "required": [
    "type"
  ]
}
```

### FileRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "file"
      ],
      "x-enumNames": [
        "FILE"
      ]
    },
    "payload": {
      "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": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Send one or more file attachments, with an optional text message."
}
```

### FlowTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "flow"
      ],
      "x-enumNames": [
        "FLOW"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "diagramID": {
          "type": "string"
        }
      },
      "required": [
        "diagramID"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Marks the conversation entering a flow, identified by its diagram ID."
  },
  "description": "Marks the conversation entering a flow, identified by its diagram ID."
}
```

### GeneralRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/BaseAction"
          }
        },
        "label": {
          "type": "string"
        }
      },
      "additionalProperties": {}
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": {},
  "description": "Represents an non-system-defined action."
}
```

### GoToTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "goto"
      ],
      "x-enumNames": [
        "GOTO"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "request": {
          "$ref": "#/components/schemas/BaseRequest"
        }
      },
      "required": [
        "request"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Instructs the client to re-send the wrapped request on the next turn."
  },
  "description": "Instructs the client to re-send the wrapped request on the next turn."
}
```

### IntentRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "intent"
      ],
      "x-enumNames": [
        "INTENT"
      ]
    },
    "payload": {
      "$ref": "#/components/schemas/IntentRequestPayload"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "description": "Trigger a specific intent from your conversation model."
}
```

### IntentRequestEntity

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "verboseValue": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/VerboseValue"
      }
    }
  },
  "required": [
    "name",
    "value"
  ]
}
```

### IntentRequestPayload

```json
{
  "type": "object",
  "properties": {
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/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": "#/components/schemas/IntentRequestEntity"
      }
    },
    "confidence": {
      "type": "number"
    }
  },
  "required": [
    "intent"
  ]
}
```

### KnowledgeBaseTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "knowledgeBase"
      ],
      "x-enumNames": [
        "KNOWLEDGE_BASE"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Reports a knowledge base retrieval: the chunks returned and the query that produced them."
  },
  "description": "Reports a knowledge base retrieval: the chunks returned and the query that produced them."
}
```

### LaunchRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "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": {}
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": {},
  "description": "Send a launch request to start a new conversation."
}
```

### LegacyIntentRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "intent"
      ],
      "x-enumNames": [
        "INTENT"
      ]
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/BaseAction"
          }
        },
        "label": {
          "type": "string"
        },
        "query": {
          "default": "",
          "type": "string"
        },
        "intent": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            }
          },
          "required": [
            "name"
          ],
          "additionalProperties": {}
        },
        "entities": {
          "default": [],
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/IntentRequestEntity"
          }
        },
        "confidence": {
          "type": "number"
        }
      },
      "required": [
        "intent",
        "entities"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "The legacy intent request type that `general-runtime` expects from its clients."
}
```

### LiveAgentHandoffContinueConversationPayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "continue_conversation"
      ],
      "x-enumNames": [
        "CONTINUE_CONVERSATION"
      ]
    }
  },
  "required": [
    "type"
  ]
}
```

### LiveAgentHandoffFileUploadPayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "file_upload"
      ],
      "x-enumNames": [
        "FILE_UPLOAD"
      ]
    },
    "files": {
      "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"
        ]
      }
    }
  },
  "required": [
    "type",
    "files"
  ]
}
```

### LiveAgentHandoffMessagePayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "message"
      ],
      "x-enumNames": [
        "MESSAGE"
      ]
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "message"
  ]
}
```

### LiveAgentHandoffProvider

```json
{
  "type": "string",
  "enum": [
    "ujet",
    "genesys",
    "kustomer",
    "dixa",
    "sunshine",
    "custom"
  ],
  "x-enumNames": [
    "UJET",
    "GENESYS",
    "KUSTOMER",
    "DIXA",
    "SUNSHINE",
    "CUSTOM"
  ]
}
```

### LiveAgentHandoffRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "live-agent-handoff"
      ],
      "x-enumNames": [
        "LIVE_AGENT_HANDOFF"
      ]
    },
    "payload": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/LiveAgentHandoffMessagePayload"
        },
        {
          "$ref": "#/components/schemas/LiveAgentHandoffFileUploadPayload"
        },
        {
          "$ref": "#/components/schemas/LiveAgentHandoffContinueConversationPayload"
        },
        {
          "$ref": "#/components/schemas/LiveAgentHandoffReturnToVoiceflowPayload"
        }
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Sent to interact with a connected live agent."
}
```

### LiveAgentHandoffReturnToVoiceflowPayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "return_to_voiceflow"
      ],
      "x-enumNames": [
        "RETURN_TO_VOICEFLOW"
      ]
    }
  },
  "required": [
    "type"
  ]
}
```

### LiveAgentHandoffTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "live-agent-handoff"
      ],
      "x-enumNames": [
        "LIVE_AGENT_HANDOFF"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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": "#/components/schemas/LiveAgentHandoffProvider"
                }
              ]
            },
            "config": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### LiveAgentHandoffWidgetConfig

```json
{
  "type": "object",
  "properties": {
    "returnToAI": {
      "type": "boolean"
    },
    "disableFileUpload": {
      "type": "boolean"
    }
  }
}
```

### LogTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "log"
      ],
      "x-enumNames": [
        "LOG"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### MessageRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "message"
      ],
      "x-enumNames": [
        "MESSAGE"
      ]
    },
    "payload": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ],
      "additionalProperties": {}
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Similar to the `text` action."
}
```

### NoReplyRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "no-reply"
      ],
      "x-enumNames": [
        "NO_REPLY"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": {},
  "description": "Represents the user failing to reply, typically sent after a reasonable timeout."
}
```

### NoReplyTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "no-reply"
      ],
      "x-enumNames": [
        "NO_REPLY"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "timeout": {
          "type": "number"
        }
      },
      "required": [
        "timeout"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### PathRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/BaseAction"
          }
        },
        "label": {
          "type": "string"
        }
      },
      "required": [
        "label"
      ],
      "additionalProperties": {}
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Continue the conversation by traveling down the specified path."
}
```

### PathTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "path"
      ],
      "x-enumNames": [
        "PATH"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        }
      },
      "required": [
        "path"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Reports which path the conversation took out of a step."
  },
  "description": "Reports which path the conversation took out of a step."
}
```

### RealtimeAgentTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "realtime-agent"
      ],
      "x-enumNames": [
        "REALTIME_AGENT"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "START"
              ],
              "x-enumNames": [
                "START"
              ]
            },
            "input": {
              "type": "object",
              "properties": {
                "encoding": {
                  "$ref": "#/components/schemas/AudioEncoding"
                },
                "sampleRate": {
                  "type": "number"
                }
              },
              "required": [
                "encoding"
              ]
            },
            "output": {
              "type": "object",
              "properties": {
                "encoding": {
                  "$ref": "#/components/schemas/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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### ReasoningTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "reasoning"
      ],
      "x-enumNames": [
        "REASONING"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### SpeakTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "speak"
      ],
      "x-enumNames": [
        "SPEAK"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ai": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "type": {
          "$ref": "#/components/schemas/TraceSpeakType"
        },
        "src": {
          "nullable": true,
          "type": "string"
        },
        "voice": {
          "type": "string"
        },
        "isPrompt": {
          "type": "boolean"
        }
      },
      "required": [
        "message",
        "type"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "A spoken response for voice channels, carrying the message text and optionally a synthesized audio source and voice name."
  },
  "description": "A spoken response for voice channels, carrying the message text and optionally a synthesized audio source and voice name."
}
```

### StableConversationScriptButtonStep

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "button"
      ],
      "x-enumNames": [
        "BUTTON"
      ]
    },
    "button": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "The label of a button the turn before offered, pressed the way the user would press it."
    }
  },
  "required": [
    "button"
  ],
  "additionalProperties": false
}
```

### StableConversationScriptRequest

```json
{
  "type": "object",
  "properties": {
    "messages": {
      "minItems": 1,
      "maxItems": 10,
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "minLength": 1,
            "maxLength": 2000
          },
          {
            "$ref": "#/components/schemas/StableConversationScriptTextStep"
          },
          {
            "$ref": "#/components/schemas/StableConversationScriptButtonStep"
          }
        ]
      },
      "description": "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]\"."
    },
    "variables": {
      "description": "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": {
      "default": "draft",
      "description": "Whether to talk to the draft or the published version of the environment. Draft unless you pass it.",
      "type": "string",
      "enum": [
        "draft",
        "published"
      ],
      "x-enumNames": [
        "DRAFT",
        "PUBLISHED"
      ]
    },
    "launch": {
      "description": "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": {
      "description": "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+.@:-]+$"
    }
  },
  "required": [
    "messages"
  ],
  "additionalProperties": false
}
```

### StableConversationScriptResponse

```json
{
  "type": "object",
  "properties": {
    "userID": {
      "type": "string",
      "description": "The conversation user ID the script ran as, for reading its state afterwards."
    },
    "transcriptID": {
      "nullable": true,
      "description": "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.",
      "type": "string"
    },
    "needsRecompile": {
      "type": "boolean",
      "description": "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."
    },
    "turns": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableConversationScriptTurn"
      },
      "description": "The launch turn first, then one turn per message sent."
    },
    "notSent": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    }
  },
  "required": [
    "userID",
    "transcriptID",
    "needsRecompile",
    "turns",
    "notSent"
  ]
}
```

### StableConversationScriptTextStep

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "text"
      ],
      "x-enumNames": [
        "TEXT"
      ]
    },
    "text": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000,
      "description": "The message the user types."
    }
  },
  "required": [
    "text"
  ],
  "additionalProperties": false
}
```

### StableConversationScriptToolCall

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The tool that ran: by the name the agent called it, or its own name when a workflow step ran it."
    },
    "arguments": {
      "type": "string",
      "description": "The arguments the agent passed, as JSON, cut to 300 characters. {} when a workflow step ran the tool."
    }
  },
  "required": [
    "name",
    "arguments"
  ]
}
```

### StableConversationScriptTurn

```json
{
  "type": "object",
  "properties": {
    "user": {
      "nullable": true,
      "description": "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.",
      "type": "string"
    },
    "agent": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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>]\"."
    },
    "repliedBy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    },
    "toolCalls": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableConversationScriptToolCall"
      },
      "description": "The tools the agent called and the tools its workflow steps ran in this turn, at most 20."
    },
    "variableChanges": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/StableConversationScriptVariableChange"
      },
      "description": "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."
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "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."
    },
    "ended": {
      "type": "boolean",
      "description": "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."
    },
    "endedBy": {
      "nullable": true,
      "description": "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.",
      "type": "string"
    }
  },
  "required": [
    "user",
    "agent",
    "repliedBy",
    "toolCalls",
    "variableChanges",
    "errors",
    "warnings",
    "ended",
    "endedBy"
  ]
}
```

### StableConversationScriptVariableChange

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "before": {
      "nullable": true,
      "description": "The value before the turn, as JSON cut to 200 characters. Null when it was not set; a null value is the string \"null\".",
      "type": "string"
    },
    "after": {
      "nullable": true,
      "description": "The value after the turn, as JSON cut to 200 characters. Null when it is not set; a null value is the string \"null\".",
      "type": "string"
    }
  },
  "required": [
    "name",
    "before",
    "after"
  ]
}
```

### StableConversationSendConfig

```json
{
  "type": "object",
  "properties": {
    "excludeTypes": {
      "description": "Trace types to drop from the response. Opt-in — when omitted, every trace is returned.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TraceType"
      }
    }
  }
}
```

### StableConversationSendRequest

```json
{
  "type": "object",
  "properties": {
    "action": {
      "$ref": "#/components/schemas/AnyRequest"
    },
    "version": {
      "type": "string",
      "enum": [
        "draft",
        "published"
      ],
      "description": "Whether to run the conversation against the draft or published version of the environment.",
      "x-enumNames": [
        "DRAFT",
        "PUBLISHED"
      ]
    },
    "sessionID": {
      "description": "The unique ID of the conversation session to continue.",
      "type": "string"
    },
    "config": {
      "description": "Options controlling how the response is shaped.",
      "allOf": [
        {
          "$ref": "#/components/schemas/StableConversationSendConfig"
        }
      ]
    }
  },
  "required": [
    "action",
    "version"
  ]
}
```

### StableConversationSendResponse

```json
{
  "type": "object",
  "properties": {
    "traces": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AnyTrace"
      }
    },
    "needsRecompile": {
      "type": "boolean",
      "description": "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."
    }
  },
  "required": [
    "traces",
    "needsRecompile"
  ]
}
```

### StreamTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "stream"
      ],
      "x-enumNames": [
        "STREAM"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "src": {
          "type": "string"
        },
        "token": {
          "type": "string"
        },
        "action": {
          "$ref": "#/components/schemas/TraceStreamAction"
        },
        "loop": {
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "iconImage": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "backgroundImage": {
          "type": "string"
        }
      },
      "required": [
        "src",
        "token",
        "action"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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."
  },
  "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."
}
```

### TestingRuntime_ActionRequest

```json
{
  "description": "Actions are self-describing operations with an associated payload.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "action"
      ],
      "x-enumNames": [
        "ACTION"
      ]
    },
    "payload": {
      "type": "object",
      "additionalProperties": {},
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_BaseAction"
          }
        },
        "label": {
          "type": "string"
        }
      }
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type"
  ]
}
```

### TestingRuntime_AlexaIntentRequest

```json
{
  "description": "Legacy intent request type that `general-runtime` expects Alexa to send",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "intent"
      ],
      "x-enumNames": [
        "INTENT"
      ]
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/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": "#/components/schemas/TestingRuntime_IntentRequestEntity"
          },
          "default": []
        },
        "confidence": {
          "type": "number"
        }
      },
      "required": [
        "data",
        "intent",
        "entities"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_AnyRequest

```json
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/TestingRuntime_LaunchRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_TextRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_FileRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_ActionRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_IntentRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_EventRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_PathRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_NoReplyRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_MessageRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_EndRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DTMFRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_LiveAgentHandoffRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_GeneralRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_AlexaIntentRequest"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_LegacyIntentRequest"
    }
  ]
}
```

### TestingRuntime_AnyTrace

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TestingRuntime_AudioTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_SpeakTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_StreamTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_BlockTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_CardTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_CarouselTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_ChannelActionTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_ChoiceTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_CompletionTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DTMFTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_EntityFillingTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_ExitTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_FlowTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_GoToTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_LogTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_NoReplyTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_PathTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_TextTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_ReasoningTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_VisualTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_KnowledgeBaseTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_CallForwardTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_RealtimeAgentTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_LiveAgentHandoffTrace"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_ToolCallTrace"
    }
  ]
}
```

### TestingRuntime_AudioEncoding

```json
{
  "type": "string",
  "enum": [
    "audio/mp3",
    "audio/x-mulaw",
    "audio/pcm"
  ],
  "x-enumNames": [
    "MP_3",
    "MULAW",
    "PCM"
  ]
}
```

### TestingRuntime_AudioTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "audio"
      ],
      "x-enumNames": [
        "AUDIO"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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": "#/components/schemas/TestingRuntime_AudioEncoding"
            },
            "duration": {
              "type": "number"
            }
          },
          "required": [
            "state",
            "content",
            "encoding"
          ]
        },
        {
          "type": "object",
          "properties": {
            "state": {
              "type": "string",
              "enum": [
                "end"
              ],
              "x-enumNames": [
                "END"
              ]
            }
          },
          "required": [
            "state"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_BaseAction

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {}
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_BaseRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {},
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type"
  ]
}
```

### TestingRuntime_BlockTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "block"
      ],
      "x-enumNames": [
        "BLOCK"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "blockID": {
          "type": "string"
        }
      },
      "required": [
        "blockID"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_Button

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "request": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TestingRuntime_BaseRequest"
        }
      ]
    }
  },
  "required": [
    "name"
  ]
}
```

### TestingRuntime_CallForwardPhone

```json
{
  "type": "object",
  "properties": {
    "addressType": {
      "type": "string",
      "enum": [
        "phone"
      ],
      "x-enumNames": [
        "PHONE"
      ]
    },
    "address": {
      "type": "string"
    },
    "extension": {
      "type": "string"
    },
    "callerIDPassthrough": {
      "type": "boolean"
    }
  },
  "required": [
    "addressType",
    "address"
  ]
}
```

### TestingRuntime_CallForwardSIP

```json
{
  "type": "object",
  "properties": {
    "addressType": {
      "type": "string",
      "enum": [
        "sip"
      ],
      "x-enumNames": [
        "SIP"
      ]
    },
    "address": {
      "type": "string"
    }
  },
  "required": [
    "addressType",
    "address"
  ]
}
```

### TestingRuntime_CallForwardTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "call-forward"
      ],
      "x-enumNames": [
        "CALL_FORWARD"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/TestingRuntime_CallForwardPhone"
        },
        {
          "$ref": "#/components/schemas/TestingRuntime_CallForwardSIP"
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_CanvasVisibility

```json
{
  "type": "string",
  "enum": [
    "full",
    "hidden",
    "cropped"
  ],
  "x-enumNames": [
    "FULL",
    "HIDDEN",
    "CROPPED"
  ]
}
```

### TestingRuntime_CardTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "cardV2"
      ],
      "x-enumNames": [
        "CARD_V_2"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "$ref": "#/components/schemas/TestingRuntime_CardTraceCard"
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_CardTraceCard

```json
{
  "type": "object",
  "properties": {
    "ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TestingRuntime_DebugTraceRef"
        }
      ]
    },
    "title": {
      "type": "string"
    },
    "buttons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_Button"
      }
    },
    "imageUrl": {
      "type": "string",
      "nullable": true
    },
    "messageID": {
      "type": "string"
    },
    "description": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "slate": {
          "type": "array",
          "items": {}
        }
      },
      "required": [
        "text"
      ]
    }
  },
  "required": [
    "title",
    "buttons",
    "imageUrl",
    "description"
  ]
}
```

### TestingRuntime_CarouselLayout

```json
{
  "type": "string",
  "enum": [
    "List",
    "Carousel"
  ],
  "x-enumNames": [
    "LIST",
    "CAROUSEL"
  ]
}
```

### TestingRuntime_CarouselTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "carousel"
      ],
      "x-enumNames": [
        "CAROUSEL"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/TestingRuntime_DebugTraceRef"
            }
          ]
        },
        "cards": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_TraceCarouselCard"
          }
        },
        "layout": {
          "$ref": "#/components/schemas/TestingRuntime_CarouselLayout"
        },
        "messageID": {
          "type": "string"
        }
      },
      "required": [
        "cards",
        "layout"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_ChannelActionTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "channel-action"
      ],
      "x-enumNames": [
        "CHANNEL_ACTION"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "payload": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "name",
        "payload"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_ChoiceTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "choice"
      ],
      "x-enumNames": [
        "CHOICE"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/TestingRuntime_DebugTraceRef"
            }
          ]
        },
        "buttons": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_Button"
          }
        },
        "messageID": {
          "type": "string"
        }
      },
      "required": [
        "buttons"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_CompletionTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "completion"
      ],
      "x-enumNames": [
        "COMPLETION"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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": "#/components/schemas/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": "#/components/schemas/TestingRuntime_DebugTraceRef"
                }
              ]
            },
            "sourceUrls": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  }
                },
                "required": [
                  "url"
                ]
              }
            },
            "messageID": {
              "type": "string"
            }
          },
          "required": [
            "state"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_DTMFDelimiter

```json
{
  "type": "string",
  "enum": [
    "#",
    "*"
  ],
  "x-enumNames": [
    "#",
    "*"
  ]
}
```

### TestingRuntime_DTMFRequest

```json
{
  "description": "Represents the result of a dial-tone input, used for phone calls.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "dtmf"
      ],
      "x-enumNames": [
        "DTMF"
      ]
    },
    "payload": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_DTMFTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "dtmf"
      ],
      "x-enumNames": [
        "DTMF"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "$ref": "#/components/schemas/TestingRuntime_DTMFTracePayload"
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_DTMFTracePayload

```json
{
  "type": "object",
  "properties": {
    "enabled": {
      "description": "Enables the new DTMF collection and configuration",
      "type": "boolean"
    },
    "timeoutInSeconds": {
      "description": "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": {
      "description": "Which key to use to end DTMF input. Defaults to '#'",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_DTMFDelimiter"
      }
    },
    "maxDigits": {
      "description": "The maximum number of digits before we finish their input",
      "type": "number",
      "maximum": 20,
      "minimum": 1
    }
  },
  "required": [
    "enabled",
    "timeoutInSeconds",
    "delimiter",
    "maxDigits"
  ]
}
```

### TestingRuntime_DebugTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "debug"
      ],
      "x-enumNames": [
        "DEBUG"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/TestingRuntime_DebugTraceRef"
            }
          ]
        },
        "type": {
          "type": "string"
        },
        "level": {
          "allOf": [
            {
              "$ref": "#/components/schemas/TestingRuntime_DebugTraceLevel"
            }
          ]
        },
        "message": {
          "type": "string"
        },
        "context": {
          "type": "string"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {}
        }
      },
      "required": [
        "message"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_DebugTraceAPIToolRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "api-tool"
      ],
      "x-enumNames": [
        "API_TOOL"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "apiToolID": {
      "type": "string"
    },
    "apiToolName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "apiToolID"
  ]
}
```

### TestingRuntime_DebugTraceAgentRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "agent"
      ],
      "x-enumNames": [
        "AGENT"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "agentID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "agentName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "agentID",
    "diagramID"
  ]
}
```

### TestingRuntime_DebugTraceFunctionRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "function"
      ],
      "x-enumNames": [
        "FUNCTION"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "functionID": {
      "type": "string"
    },
    "functionName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "functionID"
  ]
}
```

### TestingRuntime_DebugTraceIntegrationToolRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "integration-tool"
      ],
      "x-enumNames": [
        "INTEGRATION_TOOL"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    },
    "integrationToolName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "integrationToolName"
  ]
}
```

### TestingRuntime_DebugTraceLevel

```json
{
  "type": "string",
  "enum": [
    "fatal",
    "error",
    "warn",
    "info",
    "debug"
  ],
  "x-enumNames": [
    "FATAL",
    "ERROR",
    "WARN",
    "INFO",
    "DEBUG"
  ]
}
```

### TestingRuntime_DebugTraceMcpIntegrationToolRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "mcp-integration-tool"
      ],
      "x-enumNames": [
        "MCP_INTEGRATION_TOOL"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "mcpToolName": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "diagramID",
    "mcpToolName"
  ]
}
```

### TestingRuntime_DebugTraceNodeRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "node"
      ],
      "x-enumNames": [
        "NODE"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "nodeType": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "nodeType",
    "diagramID"
  ]
}
```

### TestingRuntime_DebugTracePromptRef

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "prompt"
      ],
      "x-enumNames": [
        "PROMPT"
      ]
    },
    "nodeID": {
      "type": "string"
    },
    "promptID": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "diagramName": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "nodeID",
    "promptID",
    "diagramID"
  ]
}
```

### TestingRuntime_DebugTraceRef

```json
{
  "oneOf": [
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTraceNodeRef"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTraceAgentRef"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTracePromptRef"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTraceAPIToolRef"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTraceFunctionRef"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTraceIntegrationToolRef"
    },
    {
      "$ref": "#/components/schemas/TestingRuntime_DebugTraceMcpIntegrationToolRef"
    }
  ]
}
```

### TestingRuntime_EndRequest

```json
{
  "description": "Sent to indicate the conversation has been ended.",
  "type": "object",
  "properties": {
    "type": {
      "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": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type"
  ]
}
```

### TestingRuntime_EntityFillingTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "entity-filling"
      ],
      "x-enumNames": [
        "ENTITY_FILLING"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "entityToFill": {
          "type": "string"
        },
        "intent": {
          "$ref": "#/components/schemas/TestingRuntime_IntentRequest"
        }
      },
      "required": [
        "entityToFill",
        "intent"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_EventRequest

```json
{
  "description": "Events are triggers with an associated payload.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "event"
      ],
      "x-enumNames": [
        "EVENT"
      ]
    },
    "payload": {
      "$ref": "#/components/schemas/TestingRuntime_EventRequestPayload"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_EventRequestPayload

```json
{
  "type": "object",
  "properties": {
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_BaseAction"
      }
    },
    "label": {
      "type": "string"
    },
    "event": {
      "type": "object",
      "additionalProperties": {},
      "properties": {
        "name": {
          "type": "string"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "event"
  ]
}
```

### TestingRuntime_ExitTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "end"
      ],
      "x-enumNames": [
        "END"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {}
  },
  "required": [
    "type"
  ]
}
```

### TestingRuntime_FileRequest

```json
{
  "description": "Send one or more file attachments, with an optional text message.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "file"
      ],
      "x-enumNames": [
        "FILE"
      ]
    },
    "payload": {
      "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": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_FlowTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "flow"
      ],
      "x-enumNames": [
        "FLOW"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "diagramID": {
          "type": "string"
        }
      },
      "required": [
        "diagramID"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_GeneralRequest

```json
{
  "description": "Represents an non-system-defined action.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "additionalProperties": {},
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_BaseAction"
          }
        },
        "label": {
          "type": "string"
        }
      }
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type"
  ]
}
```

### TestingRuntime_GoToTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "goto"
      ],
      "x-enumNames": [
        "GOTO"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "request": {
          "$ref": "#/components/schemas/TestingRuntime_BaseRequest"
        }
      },
      "required": [
        "request"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_IntentRequest

```json
{
  "description": "Trigger a specific intent from your conversation model.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "intent"
      ],
      "x-enumNames": [
        "INTENT"
      ]
    },
    "payload": {
      "$ref": "#/components/schemas/TestingRuntime_IntentRequestPayload"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_IntentRequestEntity

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "value": {
      "type": "string"
    },
    "query": {
      "type": "string"
    },
    "verboseValue": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_VerboseValue"
      }
    }
  },
  "required": [
    "name",
    "value"
  ]
}
```

### TestingRuntime_IntentRequestPayload

```json
{
  "type": "object",
  "properties": {
    "actions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/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": "#/components/schemas/TestingRuntime_IntentRequestEntity"
      },
      "default": []
    },
    "confidence": {
      "type": "number"
    }
  },
  "required": [
    "intent"
  ]
}
```

### TestingRuntime_KnowledgeBaseTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "knowledgeBase"
      ],
      "x-enumNames": [
        "KNOWLEDGE_BASE"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_LaunchRequest

```json
{
  "description": "Send a launch request to start a new conversation.",
  "type": "object",
  "properties": {
    "type": {
      "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": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type"
  ]
}
```

### TestingRuntime_LegacyIntentRequest

```json
{
  "description": "The legacy intent request type that `general-runtime` expects from its clients.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "intent"
      ],
      "x-enumNames": [
        "INTENT"
      ]
    },
    "payload": {
      "type": "object",
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_BaseAction"
          }
        },
        "label": {
          "type": "string"
        },
        "query": {
          "default": "",
          "type": "string"
        },
        "intent": {
          "type": "object",
          "additionalProperties": {},
          "properties": {
            "name": {
              "type": "string"
            }
          },
          "required": [
            "name"
          ]
        },
        "entities": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_IntentRequestEntity"
          },
          "default": []
        },
        "confidence": {
          "type": "number"
        }
      },
      "required": [
        "intent",
        "entities"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_LiveAgentHandoffContinueConversationPayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "continue_conversation"
      ],
      "x-enumNames": [
        "CONTINUE_CONVERSATION"
      ]
    }
  },
  "required": [
    "type"
  ]
}
```

### TestingRuntime_LiveAgentHandoffFileUploadPayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "file_upload"
      ],
      "x-enumNames": [
        "FILE_UPLOAD"
      ]
    },
    "files": {
      "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
    }
  },
  "required": [
    "type",
    "files"
  ]
}
```

### TestingRuntime_LiveAgentHandoffMessagePayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "message"
      ],
      "x-enumNames": [
        "MESSAGE"
      ]
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "type",
    "message"
  ]
}
```

### TestingRuntime_LiveAgentHandoffProvider

```json
{
  "type": "string",
  "enum": [
    "ujet",
    "genesys",
    "kustomer",
    "dixa",
    "sunshine",
    "custom"
  ],
  "x-enumNames": [
    "UJET",
    "GENESYS",
    "KUSTOMER",
    "DIXA",
    "SUNSHINE",
    "CUSTOM"
  ]
}
```

### TestingRuntime_LiveAgentHandoffRequest

```json
{
  "description": "Sent to interact with a connected live agent.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "live-agent-handoff"
      ],
      "x-enumNames": [
        "LIVE_AGENT_HANDOFF"
      ]
    },
    "payload": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/TestingRuntime_LiveAgentHandoffMessagePayload"
        },
        {
          "$ref": "#/components/schemas/TestingRuntime_LiveAgentHandoffFileUploadPayload"
        },
        {
          "$ref": "#/components/schemas/TestingRuntime_LiveAgentHandoffContinueConversationPayload"
        },
        {
          "$ref": "#/components/schemas/TestingRuntime_LiveAgentHandoffReturnToVoiceflowPayload"
        }
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_LiveAgentHandoffReturnToVoiceflowPayload

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "return_to_voiceflow"
      ],
      "x-enumNames": [
        "RETURN_TO_VOICEFLOW"
      ]
    }
  },
  "required": [
    "type"
  ]
}
```

### TestingRuntime_LiveAgentHandoffTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "live-agent-handoff"
      ],
      "x-enumNames": [
        "LIVE_AGENT_HANDOFF"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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": "#/components/schemas/TestingRuntime_LiveAgentHandoffProvider"
                }
              ]
            },
            "config": {
              "allOf": [
                {
                  "$ref": "#/components/schemas/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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_LiveAgentHandoffWidgetConfig

```json
{
  "type": "object",
  "properties": {
    "returnToAI": {
      "type": "boolean"
    },
    "disableFileUpload": {
      "type": "boolean"
    }
  }
}
```

### TestingRuntime_LogTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "log"
      ],
      "x-enumNames": [
        "LOG"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_MessageRequest

```json
{
  "description": "Similar to the `text` action.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "message"
      ],
      "x-enumNames": [
        "MESSAGE"
      ]
    },
    "payload": {
      "type": "object",
      "additionalProperties": {},
      "properties": {
        "message": {
          "type": "string"
        }
      },
      "required": [
        "message"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_NoReplyRequest

```json
{
  "description": "Represents the user failing to reply, typically sent after a reasonable timeout.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "no-reply"
      ],
      "x-enumNames": [
        "NO_REPLY"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type"
  ]
}
```

### TestingRuntime_NoReplyTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "no-reply"
      ],
      "x-enumNames": [
        "NO_REPLY"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "timeout": {
          "type": "number"
        }
      },
      "required": [
        "timeout"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_PathRequest

```json
{
  "description": "Continue the conversation by traveling down the specified path.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "additionalProperties": {},
      "properties": {
        "actions": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/TestingRuntime_BaseAction"
          }
        },
        "label": {
          "type": "string"
        }
      },
      "required": [
        "label"
      ]
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_PathTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "path"
      ],
      "x-enumNames": [
        "PATH"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        }
      },
      "required": [
        "path"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_RealtimeAgentTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "realtime-agent"
      ],
      "x-enumNames": [
        "REALTIME_AGENT"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "action": {
              "type": "string",
              "enum": [
                "START"
              ],
              "x-enumNames": [
                "START"
              ]
            },
            "input": {
              "type": "object",
              "properties": {
                "encoding": {
                  "$ref": "#/components/schemas/TestingRuntime_AudioEncoding"
                },
                "sampleRate": {
                  "type": "number"
                }
              },
              "required": [
                "encoding"
              ]
            },
            "output": {
              "type": "object",
              "properties": {
                "encoding": {
                  "$ref": "#/components/schemas/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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_ReasoningTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "reasoning"
      ],
      "x-enumNames": [
        "REASONING"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_SpeakTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "speak"
      ],
      "x-enumNames": [
        "SPEAK"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ai": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "type": {
          "$ref": "#/components/schemas/TestingRuntime_TraceSpeakType"
        },
        "src": {
          "type": "string",
          "nullable": true
        },
        "voice": {
          "type": "string"
        },
        "isPrompt": {
          "type": "boolean"
        }
      },
      "required": [
        "message",
        "type"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_StreamTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "stream"
      ],
      "x-enumNames": [
        "STREAM"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "src": {
          "type": "string"
        },
        "token": {
          "type": "string"
        },
        "action": {
          "$ref": "#/components/schemas/TestingRuntime_TraceStreamAction"
        },
        "loop": {
          "type": "boolean"
        },
        "title": {
          "type": "string"
        },
        "iconImage": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "backgroundImage": {
          "type": "string"
        }
      },
      "required": [
        "src",
        "token",
        "action"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_TextRequest

```json
{
  "description": "Send the user response as a raw text payload.",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "text"
      ],
      "x-enumNames": [
        "TEXT"
      ]
    },
    "payload": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string"
        }
      }
    }
  },
  "additionalProperties": {},
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_TextTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "text"
      ],
      "x-enumNames": [
        "TEXT"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ai": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/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"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_ToolCallTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "tool-call"
      ],
      "x-enumNames": [
        "TOOL_CALL"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_TraceCarouselCard

```json
{
  "type": "object",
  "properties": {
    "ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TestingRuntime_DebugTraceRef"
        }
      ]
    },
    "title": {
      "type": "string"
    },
    "buttons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_Button"
      }
    },
    "imageUrl": {
      "type": "string",
      "nullable": true
    },
    "messageID": {
      "type": "string"
    },
    "description": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "slate": {
          "type": "array",
          "items": {}
        }
      },
      "required": [
        "text"
      ]
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "title",
    "buttons",
    "imageUrl",
    "description"
  ]
}
```

### TestingRuntime_TracePath

```json
{
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "event": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TestingRuntime_BaseRequest"
        }
      ]
    }
  }
}
```

### TestingRuntime_TraceSpeakType

```json
{
  "type": "string",
  "enum": [
    "audio",
    "message"
  ],
  "x-enumNames": [
    "AUDIO",
    "MESSAGE"
  ]
}
```

### TestingRuntime_TraceStreamAction

```json
{
  "type": "string",
  "enum": [
    "LOOP",
    "PLAY",
    "PAUSE",
    "END"
  ],
  "x-enumNames": [
    "LOOP",
    "PLAY",
    "PAUSE",
    "END"
  ]
}
```

### TestingRuntime_TraceType

```json
{
  "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

```json
{
  "type": "object",
  "properties": {
    "rawText": {
      "type": "string"
    },
    "canonicalText": {
      "type": "string"
    },
    "startIndex": {
      "type": "number"
    }
  },
  "required": [
    "rawText",
    "canonicalText",
    "startIndex"
  ]
}
```

### TestingRuntime_VisualTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "visual"
      ],
      "x-enumNames": [
        "VISUAL"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TestingRuntime_TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "$ref": "#/components/schemas/TestingRuntime_VisualTraceImage"
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### TestingRuntime_VisualTraceImage

```json
{
  "type": "object",
  "properties": {
    "visualType": {
      "type": "string",
      "enum": [
        "image"
      ],
      "x-enumNames": [
        "IMAGE"
      ]
    },
    "image": {
      "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": "#/components/schemas/TestingRuntime_CanvasVisibility"
        }
      ]
    }
  },
  "required": [
    "image"
  ]
}
```

### TextRequest

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "text"
      ],
      "x-enumNames": [
        "TEXT"
      ]
    },
    "payload": {
      "type": "string"
    },
    "diagramID": {
      "type": "string"
    },
    "time": {
      "type": "number"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "additionalProperties": {},
  "description": "Send the user response as a raw text payload."
}
```

### TextTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "text"
      ],
      "x-enumNames": [
        "TEXT"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "type": "object",
      "properties": {
        "ai": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        },
        "ref": {
          "allOf": [
            {
              "$ref": "#/components/schemas/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"
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ]
}
```

### ToolCallTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "tool-call"
      ],
      "x-enumNames": [
        "TOOL_CALL"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "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"
          ]
        }
      ]
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "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`."
  },
  "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`."
}
```

### TraceCarouselCard

```json
{
  "type": "object",
  "properties": {
    "ref": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DebugTraceRef"
        }
      ]
    },
    "title": {
      "type": "string"
    },
    "buttons": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Button"
      }
    },
    "imageUrl": {
      "nullable": true,
      "type": "string"
    },
    "messageID": {
      "type": "string"
    },
    "description": {
      "type": "object",
      "properties": {
        "text": {
          "type": "string"
        },
        "slate": {
          "type": "array",
          "items": {}
        }
      },
      "required": [
        "text"
      ]
    },
    "id": {
      "type": "string"
    }
  },
  "required": [
    "title",
    "buttons",
    "imageUrl",
    "description"
  ]
}
```

### TracePath

```json
{
  "type": "object",
  "properties": {
    "label": {
      "type": "string"
    },
    "event": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BaseRequest"
        }
      ]
    }
  }
}
```

### TraceSpeakType

```json
{
  "type": "string",
  "enum": [
    "audio",
    "message"
  ],
  "x-enumNames": [
    "AUDIO",
    "MESSAGE"
  ]
}
```

### TraceStreamAction

```json
{
  "type": "string",
  "enum": [
    "LOOP",
    "PLAY",
    "PAUSE",
    "END"
  ],
  "x-enumNames": [
    "LOOP",
    "PLAY",
    "PAUSE",
    "END"
  ]
}
```

### TraceType

```json
{
  "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"
  ]
}
```

### VerboseValue

```json
{
  "type": "object",
  "properties": {
    "rawText": {
      "type": "string"
    },
    "canonicalText": {
      "type": "string"
    },
    "startIndex": {
      "type": "number"
    }
  },
  "required": [
    "rawText",
    "canonicalText",
    "startIndex"
  ]
}
```

### VisualTrace

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "visual"
      ],
      "x-enumNames": [
        "VISUAL"
      ]
    },
    "paths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TracePath"
      }
    },
    "defaultPath": {
      "type": "number"
    },
    "time": {
      "type": "number"
    },
    "turnID": {
      "type": "string"
    },
    "handleID": {
      "type": "string"
    },
    "payload": {
      "$ref": "#/components/schemas/VisualTraceImage"
    }
  },
  "required": [
    "type",
    "payload"
  ],
  "x-vf-doc": {
    "description": "Displays an image, with optional device sizing and layout options."
  },
  "description": "Displays an image, with optional device sizing and layout options."
}
```

### VisualTraceImage

```json
{
  "type": "object",
  "properties": {
    "visualType": {
      "type": "string",
      "enum": [
        "image"
      ],
      "x-enumNames": [
        "IMAGE"
      ]
    },
    "image": {
      "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": "#/components/schemas/CanvasVisibility"
        }
      ]
    }
  },
  "required": [
    "image"
  ]
}
```
