Retrieve Response

GET /agents/{agentId}/conversations/{conversationId}/response/{responseId}

Path Parameters

---

agentId string Required

The agent id

conversationId string Required

The conversation id

responseId string Required

The response id

---

Response Type

type InconvoResponseRetrieve = {
  id: string;
  input: {
    message: string;
    context: Record<string, unknown>;
  };
  output: {
    type: "text" | "chart" | "table";
    message: string;
    chart?: {
      $schema: "https://vega.github.io/schema/vega-lite/v5.json";
      // ... vega-lite spec
    };
    table?: {
      head: string[];
      body: string[][];
    };
  };
};

Request

Node.js

import Inconvo from "@inconvoai/node";

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

const response = await inconvo.agents.conversations.response.retrieve(
  "resp_abc123",
  {
    agentId: "agt_123",
    conversation_id: "convo_abc123"
  }
);

console.log(response);

Response

{
  "id": "e45f7d78-36d5-4130-926a-78e334255609",
  "input": {
    "message": "What are the top products last year?",
    "context": { "organisationId": 1 }
  },
  "output": {
    "type": "table",
    "message": "Top products by quantity sold in 2025 (2025-01-01 to 2025-12-31).",
    "table": {
      "head": ["Product", "Quantity Sold"],
      "body": [
        ["iPhone 15", "8456"],
        ["MacBook Pro", "3421"],
        ["AirPods Pro", "2890"],
        ["iPad Pro", "2134"],
        ["Apple Watch", "1876"]
      ]
    }
  }
}

curl -X GET "https://app.inconvo.ai/api/v1/agents/agt_123/conversations/convo_51524c88/response/resp_abc123" \
  -H "Authorization: Bearer $INCONVO_API_KEY"

Response

{
  "id": "e45f7d78-36d5-4130-926a-78e334255609",
  "input": {
    "message": "What are the top products last year?",
    "context": { "organisationId": 1 }
  },
  "output": {
    "type": "table",
    "message": "Top products by quantity sold in 2025 (2025-01-01 to 2025-12-31).",
    "table": {
      "head": ["Product", "Quantity Sold"],
      "body": [
        ["iPhone 15", "8456"],
        ["MacBook Pro", "3421"],
        ["AirPods Pro", "2890"],
        ["iPad Pro", "2134"],
        ["Apple Watch", "1876"]
      ]
    }
  }
}