If you haven’t set up your endpoints, visit the Customer Endpoints section for instructions.
Your First Request
We have designed a simple and reliable API for enqueuing your conversations. To receive your first reply, simply follow the steps below 👍.1. Authentication
We use access keys to authenticate requests made to our API. An access key is required to start sending requests. To create one, visit your customer dashboard under “Project > Access Keys” section. Once you have your access key, include it in every request using the HTTP headerAuthorization
like this Bearer {api-key}
(e.g. Authorization: Bearer sk-proj-XXXXXXXXXX
).
2. Request Parameters
Conversation enqueue endpoint requires the following parameters:Name | Description |
---|---|
userProfileId | Your user/customer profile ID, used to retrieve data from your Profile Endpoint. |
personaProfileId | Your persona/virtual profile ID, used to retrieve data from your Profile Endpoint. |
language | The desired language for your answer. For today’s example, we are going to use EN (english). |
Additional parameters are available in API Reference > Content Creation > Endpoints > Enqueue Conversation.
3. Building Your Request Body
Our API expects a request containing JSON. Below is an example of the expected format:4. Sending Your Request
You have to send a request using a cURL command.5. Receiving Your Reply
You will receive a reply as soon as possible. If the user replies again, simply enqueue the conversation again, and we’ll continue from there!Check your project logs for any errors from your customer endpoints. To do this, go to your customer dashboard, navigate to the Project section in the left sidebar, and select Logs.