POST
/
chatbot
/
{id}
/
run
curl --request POST \
  --url https://api.vectorshift.ai/v1/chatbot/{id}/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "text": "<string>",
  "conversation_id": "<string>",
  "stream": false,
  "filter": {
    "filter_items": [
      {
        "object_id": "<string>",
        "item_id": "<string>",
        "document_id": "<string>"
      }
    ],
    "selection_mode": "ALL"
  },
  "generate_follow_up_questions": false,
  "number_of_follow_up_questions": 123,
  "slack_channel_id": "<string>"
}'
{
  "status": "success",
  "conversation_id": "<string>",
  "output_message": "<string>",
  "follow_up_questions": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication using API key

Path Parameters

id
string
required

Chatbot ID

Body

text
string
required
audio
file

Base64 encoded audio data

conversation_id
string
stream
boolean
default:false
filter
object
generate_follow_up_questions
boolean
default:false
number_of_follow_up_questions
integer
slack_channel_id
string

Response

200
application/json
Successful response. Returns regular JSON response or SSE stream based on 'stream' parameter.
status
enum<string>
required
Available options:
success,
failed
conversation_id
string
required
output_message
string
required
follow_up_questions
string[]