Create Conversation

Create a new conversation

post

/v1/conversation/create

Description

Create a new conversation with the given parameters and optional messages. The conversation will be initialized with the the backstory, model, dataset, skillset and other configuration options of the bot. Alternatively the conversation can be initialized directly with the backstory, model, dataset, skillset and other configuration options.

An array of messages can be included in the request body to add to the conversation.

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Request Body * Required

Request Body Schema: application/json

namestring

The associated name

descriptionstring

The associated description

metaobject

Meta data information

contactIdstring

The contact id assigned to this conversation

messagesarray

An array of messages to be added to the conversation

typestring

The type of the message

textstring

The text of the message

botIdstring

The ID of the bot this configuration is using


curl -X POST "https://api.chatbotkit.com/v1/conversation/create" \
-H "Authorization: Bearer $CHATBOTKIT_API_SECRET" \
-H "Content-Type: application/json" \
--data-binary @- << EOF
{"name":"string",
"description":"string",
"meta":"object",
"contactId":"string",
"messages":[{"type":"string",
"text":"string"
}
],
"botId":"string"
}
EOF

{"id":"string",
"messages":[{"type":"string",
"text":"string"
}
]
}

The conversation was created successfully