Create a response

Creates a response in a conversation. Provide a message string, and Inconvo will return the response in text, chart, or table format.

POST /conversations/:id/response

Body Parameters

message string Required

The message to send to the conversation.

stream boolean

Whether to stream the response. When true, returns a stream of server-sent events. See the streaming guide for more details.

Response Type

type InconvoResponse = {
  id: string;
  conversationId: string;
  message: string;
  type: "text" | "chart" | "table";
  chart?: {
    type: "line" | "bar";
    data: {
      label: string;
      value: number;
    }[];
    title: string;
    xLabel: string;
    yLabel: string;
  };
  table?: {
    head: string[];
    body: string[][];
  };
};

Request

import Inconvo from "@inconvoai/node";

const inconvo = new Inconvo({
  apiKey: process.env.INCONVO_API_KEY
});

const response = await inconvo.conversations.response.create("convo_abc123", {
  message: "What is our most popular product?"
});

console.log(response);

{
  "id": "57ad0f60-617d-4d4c-a2ed-63e3bf0413ff",
  "conversationId": "convo_abc123",
  "type": "text",
  "message": "Your most popular product is the iPhone 15, with a total of 24,840 orders."
}

Chart Example

Request

const response = await inconvo.conversations.response.create("convo_abc123", {
  message: "Show me our revenue trend for this year."
});

{
  "id": "19ab658b-94f7-45c1-97b7-777711446194",
  "conversationId": "convo_abc123",
  "type": "chart",
  "message": "Here is your monthly revenue trend for 2025 so far. The chart shows total revenue for each month from January to May.",
  "chart": {
    "type": "line",
    "data": [
      {
        "label": "2025-01",
        "value": 3019366.23
      },
      {
        "label": "2025-02",
        "value": 2766805.29
      },
      {
        "label": "2025-03",
        "value": 3026689.03
      },
      {
        "label": "2025-04",
        "value": 3059223.96
      },
      {
        "label": "2025-05",
        "value": 57216.21
      }
    ],
    "title": "Monthly Revenue Trend for 2025",
    "xLabel": "Month",
    "yLabel": "Revenue ($)"
  }
}

Table Example

Request

const response = await inconvo.conversations.response.create("convo_abc123", {
  message: "What were my top 5 selling products last quarter?"
});

{
  "id": "2dc27a80-5ef9-4d6a-b1a4-c0f45f5f8aba",
  "conversationId": "convo_abc123",
  "type": "table",
  "message": "Here are your top 5 selling products from last quarter:",
  "table": {
    "head": [
      "Product",
      "Units Sold"
    ],
    "body": [
      [
        "iPhone 15",
        "4366"
      ],
      [
        "MacBook Pro",
        "1793"
      ],
      [
        "AirPods Pro",
        "1354"
      ],
      [
        "iPad Pro",
        "1212"
      ],
      [
        "Apple Watch",
        "1019"
      ]
    ]
  }
}

Create a response

Body Parameters

Response Type

Chart Example

Table Example

Getting Started

Guides

Conversations API

REST

Streaming