Create Conversation Starter

POST

/v2/api/conversation-starter

Overview
This endpoint enables users to create a new conversation starter by submitting a set of thought-provoking questions linked to a specific document and corpus. It facilitates the generation of contextual questions that can be used to initiate meaningful conversations related to a particular content piece.

Functionality

Input Requirements
Users must provide the following in the request body:

document_id: ID of the document that the conversation starter is based on.

corpus_id: ID of the corpus to which the document belongs.

question_1: The first conversation starter question.

question_2: The second conversation starter question.

question_3: The third conversation starter question.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/conversation-starter' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "document_id": 19600,
    "corpus_id": 1297,
    "question_1": "What is prompt engineering?",
    "question_2": "How does the attention mechanism work?",
    "question_3": "What are LLMs?"
}'

Response Example

{
    "id": 3742,
    "question_1": "What is prompt engineering 2?",
    "question_2": "What is prompt engineering 2?",
    "question_3": "What is prompt engineering 2?",
    "document": 19201,
    "corpus": 1345
}

Request

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Successfully created a new conversation starter.

Body

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🔴500Server Error

Email Authorize

Get Conversation Starters