Quickstart

Prerequisites

Create a free API key Sign up for Inconvo and create an API key to start using the API.

Our free plan allows you to explore the Inconvo platform and API with our demo database.

Start a conversation

curl -X POST 'https://app.inconvo.ai/api/v1/conversations' \
  -H "Authorization: Bearer $INCONVO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d $'{"context": {"organisationId": 1}}'

Store the id from the response which looks like:

{ "id": "convo_ccd36daf-5917-4bfe-a77c-cca5315c892f" }

Create a response

Within the conversation you just created, send a message to create a response.

Sub in the previously stored conversation id for {id} in the path of the URL

curl -X POST "https://app.inconvo.ai/api/v1/conversations/{id}/response" \
  -H "Authorization: Bearer $INCONVO_API_KEY" \
  -H "Content-Type: application/json" \
  -d $'{"message": "What is our most popular product?"}'

The response will look something like:

{
  "id": "58db5e15-afa2-44b3-bf92-4a78c068b441",
  "conversationId": "convo_ccd36daf-5917-4bfe-a77c-cca5315c892f",
  "type": "text",
  "message": "Our most popular product is the iPhone 15, with the highest total quantity sold to date."
}

Next steps

View Conversation Logs The conversation is available to view on the Inconvo platform, check it out.