Step 1: Get API Key
Fill out the form on the below page: We suggest using a personal email to ensure no spam filtering. Furthermore, please check your spam folder. It may take a few minutes to arrive
Once you have received the Welcome email you will see an API key (see screenshot below) Please save this securely. This API key can be shared with other developers on your team. It may take up to 60 minutes for the API key to become active on all edge servers.
All the code samples below assume the following environment variables are exported
To test if it is active use the following endpoint:
Step 2: Users
Whenever you have a new user of your service that you want to enable communication with the MKCLOUD on behalf of, you need to register them. This can correspond to the first time the application is opened or the first message sent to MKCLOUD on behalf of the uuid.
The first time you need to send a request call the create_end_user endpoint passing in a UUID that will identify the user going forward. We suggest reusing your own internal UUID for the user.
Note that the MKCLOUD , and expected to be different. This should be unique for each user.returned is the
Thefor the user will need to be passed for all requests made to MKCLOUD on behalf of that user.
You can get a new an existing UUID. This should only be done with reason, as it is a slower request.and, if expired, a new refresh Token for a user by calling the register endpoint using
Step 3: Conversational API
With anfor a user and your API key you can start making conversational API requests.
Before the first turn in your multi-turn dialogue you should call the endpoint. This will ensure any previous conversation context is cleared. Otherwise, if there is a previous ongoing conversation that was never cleared, it will be continued from that point.
We provide 2 different APIs for sending messages to our backend on behalf of the user.
The batch API returns an array of messages that should be sent back to the user in order.
You can use the "card" object to quickly build out an interface. This is found under
The ALPHA and the enhanced cards are going to be released by the beginning of Augustshould be used for the "action button", it is currently in
Thelink can be used to deeplink to the MeetKai quick apps on supported platforms (stability coming end of July)
Thelink can be used to deep link to the MeetKai VA App on supported platforms if it is installed (stability coming end of July)
is an optional parameter (see API docs). Setting this value will reduce results to the subset of domains. Possible domain values are: streaming, restaurant, news, recipe, shopping, beer, book, fitness, gaming, meditation, podcast, and wine.
The streaming message API can be called exactly as the message_batch API. The difference is that the streaming API will stream back messages as JSON lines at a time. This enables rendering results back to the user faster.
By sending a follow up message with the same Authorization token, you can continue the dialogue. This is done by default. If this is not intended, then you need to call the endpoint.
Step 4: Bulk API