Quickstart

1. Create an Inconvo Account

   You can sign up for a free account here.

2. Create your first Data Agent

   Once you’ve created an account, follow the steps in the app to:

   1. Complete your account details.
   2. Create your first Data Agent.
   
   

3. Install Inconvo SDK

   If you need to initialize a project run:

   mkdir inconvo-quickstart && cd inconvo-quickstart && npm init -y

   Install the Inconvo SDK to your project by running the following command in your terminal.

   npm i @inconvoai/node dotenv

4. Obtain an API key & Agent ID

   1. Navigate to the Inconvo Dashboard.
   2. Copy your Agent ID from the sidebar.
   3. Paste your Agent ID into your .env file.
   4. Create an API key.
   5. Paste your Inconvo API key into your .env file.

   .env

   INCONVO_API_KEY=***
   INCONVO_AGENT_ID=***

   
   

5. Write code for calling Data Agent

   We’ll write the minimal code for starting a conversation with the Data Agent and sending a message to elicit a response.

   index.ts

   import "dotenv/config";
   import { randomUUID } from "node:crypto";
   import Inconvo from "@inconvoai/node";
   
   const inconvo = new Inconvo({
     apiKey: process.env.INCONVO_API_KEY,
   });
   
   async function main() {
     const agentConvo = await inconvo.agents.conversations.create(
       process.env.INCONVO_AGENT_ID!,
       {
         userIdentifier: randomUUID().toString(),
         userContext: {
           organisationId: 1,
         }, // NOTE: This is userContext for DemoAgent - change as needed
       },
     );
   
     const agentResponse = await inconvo.agents.conversations.response.create(
       agentConvo.id!,
       {
         agentId: process.env.INCONVO_AGENT_ID!,
         message: "Hello agent!",
         stream: false,
       },
     );
     console.log(agentResponse);
   }
   
   main().catch(console.error);

6. Call your first Data Agent

   npx tsx ./index.ts

   Note

   If the code returns BadRequestError: 400 Invalid userContext, check the configured userContext for your agent and update as required.

Next Steps

Now that you have a working Data Agent, explore more capabilities:

• Render responses - Display text, charts and tables on your front-end
• Customize the agent - Use the semantic model to define how data should be understood and accessed by your agent.
• Explore a sample app - A practical demonstration of integrating Inconvo in your codebase.