Usage

import { ReyGrid } from "reygrid";

const client = new ReyGrid({ apiKey: process.env.REYGRID_API_KEY });

const res = await client.chat("{AgentId}", "Check my current subscription", {
  userId: "user-42",
  tools: [
    {
      type: "function",
      function: {
        name: "check_subscription",
        instructions: "Opens the customer's current plan, renewal date, and payment status.",
        parameters: {
          type: "object",
          properties: { userId: { type: "string", description: "The customer user id" } },
          required: ["userId"],
        },
      },
    },
  ],
});

console.log(res.output.reply.content);
console.log(res.output.finish_reason, res.messageId, res.conversationId);
console.log(res.usage.credits);

const res = await client.chat("{AgentId}", "What is the status of my account?", {
  userId: "user-42",
  tools: [checkSubscriptionTool],
  results: [
    {
      toolCallId: "call_xyz",
      output: JSON.stringify({ plan: "pro", status: "active" }),
    },
  ],
});

const res = await client.listConversations("{AgentId}", { page: 1, size: 20 });
for (const c of res.conversations) {
  console.log(c.conversationId, c.userId, c.messagesCount, c.createdAt);
}
console.log(res.pagination.hasNextPage, res.pagination.totalConversations);

const res = await client.deleteConversation("{AgentId}", "user-42");
console.log(res.deletedMessages.count);

const res = await client.listMessages("{AgentId}", "user-42", { page: 1, size: 50 });
for (const m of res.messages) {
  console.log(m.role, m.content);
  for (const call of m.tool_calls ?? []) {
    console.log("  tool call:", call.id, call.function.name, call.status);
  }
}

const res = await client.deleteMessage("{AgentId}", "user-42", "MESSAGE_ID", true);
console.log(res.deletedMessages.count);

const { canceled } = await client.cancelToolCall("{AgentId}", "user-42", "call_xyz");

const { agents } = await client.listAgents(); // the agents this key can use
const { agent } = await client.getAgent("{AgentId}");
console.log(agent.sources, agent.storage); // { text, qa, file, website }, { used, limit }

await client.updateAgent("{AgentId}", { instructions: "Answer in a friendly tone." });

import { openAsBlob } from "node:fs";

await client.addTextSource("{AgentId}", { title: "Refund policy", content: "…" });
await client.addQaSource("{AgentId}", { question: "Do you ship abroad?", answer: "…" });
await client.uploadFile("{AgentId}", await openAsBlob("handbook.pdf"), "handbook.pdf");
const { pagesCrawled } = await client.crawlWebsite("{AgentId}", "https://docs.example.com");

const { sources } = await client.listSources("{AgentId}", { type: "text", search: "refund" });
await client.deleteSource("{AgentId}", sources[0].id);

const { results } = await client.search("{AgentId}", "How do I get a refund?", { limit: 3 });

await client.rateMessage("{AgentId}", "user-42", "msg_abc123", { rating: "up" });

const { models } = await client.listModels();
const report = await client.getUsageReport({ days: 7 }); // balance, totals, daily, agents

for await (const page of client.paginateConversations("{AgentId}", 50).pages()) {
  for (const convo of page.data) {
    console.log(convo.conversationId, convo.messagesCount);
  }
}

const allMessages = await client.paginateMessages("{AgentId}", "user-42").all();