---
title: "Route used to test the ai_chat_starter_service"
method: POST
path: "/api/v5/admin/ai-chat/messages/start-convo"
tags: ["AI Chat"]
---

# Route used to test the ai_chat_starter_service

`POST /api/v5/admin/ai-chat/messages/start-convo`

## Request

- Base URL: `https://api.pavlok.com`
- URL: `https://api.pavlok.com/api/v5/admin/ai-chat/messages/start-convo`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/pavlok/apis/pavlok-api-v5/docs/api/v5/admin/ai-chat/messages/start-convo/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- BodyAiChatMessagesAdminCreateNonStreamApiV5AdminAiChatMessagesStartConvoPost
  - `message` AiChatMessageInCreate, required
    - `threadId` integer
    - `role` string: Role of the message sender (e.g., user, bot)
    - `content` string: Full message content
    - `displayContent` string: Message content to be displayed
    - `hidden` boolean: Flag to hide/show the message
    - `functionName` string: Tools function name
    - `toolCalls` object[]: Tool calls
    - `toolCallId` string: Tool call id

## Response `201`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/pavlok/apis/pavlok-api-v5.md) - [All operations](https://skmtc.dev/pavlok/apis/pavlok-api-v5/llms.txt) - [OpenAPI document](https://skmtc.dev/pavlok/apis/pavlok-api-v5/revisions/3d192098b1ac?raw)