Complete Conversation Message

Send and receive a conversation response

post

/v1/conversation/{conversationId}/complete

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

conversationIdstring* Required

The ID of the conversation to receive message from

Request Body * Required

Request Body Schema: application/json

textstring

The text of the message to send

entitiesarray

Known entities

typestring

The entity type

beginnumber

Start offset

endnumber

End offset

textstring

The text value of the entity

replacementobject

beginnumber

Start offset

endnumber

End offset

textstring

The text value of the replacement


curl -X POST "https://api.chatbotkit.com/v1/conversation/{conversationId}/complete" \
-H "Authorization: Bearer $CHATBOTKIT_API_SECRET" \
-H "Content-Type: application/json" \
--data-binary @- << EOF
{"text":"string",
"entities":[{"type":"string",
"begin":"number",
"end":"number",
"text":"string",
"replacement":{"begin":"number",
"end":"number",
"text":"string"
}
}
]
}
EOF

{"id":"string",
"text":"string",
"usage":{"token":"number"
}
}

The message was received successfully