@answerloops/agent-sdk 0.1.0

package/README.md

@@ -0,0 +1,50 @@
+# @answerloops/agent-sdk
+
+Typed Node/browser client for the [answerLoops Agent API](https://answerloops.com/docs/integrations/agent-api) — search the knowledge base, read the FAQ digest, list/create tickets, and generate grounded answers.
+
+## Install
+
+```bash
+npm install @answerloops/agent-sdk
+```
+
+## Usage
+
+```ts
+import { AgentClient } from "@answerloops/agent-sdk";
+
+const client = new AgentClient({
+  apiKey: process.env.ANSWERLOOPS_API_KEY!, // al_live_...
+  // baseUrl: "https://your-self-hosted-instance.example.com", // defaults to https://answerloops.com
+});
+
+const { results } = await client.searchKb({ query: "how do I reset my api key" });
+
+const answer = await client.generateAnswer({ question: "How do I reset my API key?" });
+
+const ticket = await client.createTicket({ content: "My webhook stopped firing." });
+
+const { tickets } = await client.getTickets({ status: "open", limit: 10 });
+```
+
+Every key carries least-privilege scopes (`kb:read`, `faq:read`, `tickets:read`, `tickets:write`, `answers:write`) set in **Settings → API Keys**. A call against a scope the key doesn't have throws `AgentApiError` with `status === 403`.
+
+## Errors
+
+Non-2xx responses throw `AgentApiError`:
+
+```ts
+import { AgentApiError } from "@answerloops/agent-sdk";
+
+try {
+  await client.generateAnswer({ question: "..." });
+} catch (err) {
+  if (err instanceof AgentApiError) {
+    console.error(err.status, err.body);
+  }
+}
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,109 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AgentApiError: () => AgentApiError,
+  AgentClient: () => AgentClient
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var AgentApiError = class extends Error {
+  status;
+  body;
+  constructor(status, body, message) {
+    super(message);
+    this.name = "AgentApiError";
+    this.status = status;
+    this.body = body;
+  }
+};
+var DEFAULT_BASE_URL = "https://answerloops.com";
+var AgentClient = class {
+  apiKey;
+  baseUrl;
+  fetchImpl;
+  constructor(options) {
+    if (!options.apiKey) {
+      throw new Error("AgentClient requires an apiKey (Settings -> API Keys).");
+    }
+    this.apiKey = options.apiKey;
+    this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this.fetchImpl = options.fetch ?? fetch;
+  }
+  /** GET /api/agent/kb/search — requires the `kb:read` scope. */
+  searchKb(params) {
+    const query = new URLSearchParams({ query: params.query });
+    if (params.limit !== void 0) query.set("limit", String(params.limit));
+    return this.request("GET", `/api/agent/kb/search?${query}`);
+  }
+  /** GET /api/agent/faq — requires the `faq:read` scope. */
+  getFaq() {
+    return this.request("GET", "/api/agent/faq");
+  }
+  /** GET /api/agent/tickets — requires the `tickets:read` scope. */
+  getTickets(params = {}) {
+    const query = new URLSearchParams();
+    if (params.status) query.set("status", params.status);
+    if (params.priority) query.set("priority", params.priority);
+    if (params.category) query.set("category", params.category);
+    if (params.limit !== void 0) query.set("limit", String(params.limit));
+    const qs = query.toString();
+    return this.request("GET", `/api/agent/tickets${qs ? `?${qs}` : ""}`);
+  }
+  /** POST /api/agent/tickets — requires the `tickets:write` scope. */
+  createTicket(params) {
+    return this.request("POST", "/api/agent/tickets", {
+      content: params.content,
+      authorName: params.authorName,
+      idempotencyKey: params.idempotencyKey
+    });
+  }
+  /** POST /api/agent/answers — requires the `answers:write` scope. */
+  generateAnswer(params) {
+    return this.request("POST", "/api/agent/answers", { question: params.question });
+  }
+  async request(method, path, body) {
+    const res = await this.fetchImpl(`${this.baseUrl}${path}`, {
+      method,
+      headers: {
+        Authorization: `Bearer ${this.apiKey}`,
+        ...body ? { "Content-Type": "application/json" } : {}
+      },
+      body: body ? JSON.stringify(body) : void 0
+    });
+    const text = await res.text();
+    const data = text ? JSON.parse(text) : void 0;
+    if (!res.ok) {
+      throw new AgentApiError(
+        res.status,
+        data,
+        data?.error ?? `Agent API request failed: ${res.status}`
+      );
+    }
+    return data;
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AgentApiError,
+  AgentClient
+});

package/dist/index.d.cts

@@ -0,0 +1,95 @@
+interface KbSearchResult {
+    question: string;
+    answer: string;
+    score: number;
+}
+interface KbSearchResponse {
+    results: KbSearchResult[];
+}
+type TicketStatus = "open" | "in_progress" | "resolved" | "closed";
+type TicketPriority = "critical" | "high" | "medium" | "low";
+type TicketCategory = "bug" | "feature_request" | "documentation" | "how_to" | "general_question";
+interface Ticket {
+    id: number;
+    content: string;
+    category: TicketCategory | null;
+    priority: string;
+    status: string;
+    ai_summary: string | null;
+    created_at: string;
+}
+interface GetTicketsParams {
+    status?: TicketStatus;
+    priority?: TicketPriority;
+    category?: TicketCategory;
+    /** 1-20, defaults to 10 */
+    limit?: number;
+}
+interface GetTicketsResponse {
+    tickets: Ticket[];
+}
+interface CreateTicketParams {
+    /** The user's question or issue, verbatim. Max 4000 characters. */
+    content: string;
+    /** Name/identifier of the end user this ticket is on behalf of. */
+    authorName?: string;
+    /** Retrying with the same key returns the original ticket instead of opening a duplicate. */
+    idempotencyKey?: string;
+}
+interface GenerateAnswerParams {
+    /** Max 2000 characters. */
+    question: string;
+}
+interface GenerateAnswerResponse {
+    answer: string;
+    confidence: number;
+    answered_fully: boolean;
+    high_confidence: boolean;
+}
+interface SearchKbParams {
+    /** Max 2000 characters. */
+    query: string;
+    /** 1-20, defaults to 5 */
+    limit?: number;
+}
+/** Shape of the `Error` schema returned on 400/401/403/429 responses. */
+interface AgentApiErrorBody {
+    error: string;
+    [key: string]: unknown;
+}
+
+interface AgentClientOptions {
+    /** API key from Settings -> API Keys, `al_live_...`. Shared with the MCP server. */
+    apiKey: string;
+    /**
+     * Base URL of the answerLoops instance. Defaults to the hosted cloud
+     * (`https://answerloops.com`). Point this at a self-hosted instance instead.
+     */
+    baseUrl?: string;
+    /** Overrides the global `fetch` — mainly for tests. */
+    fetch?: typeof fetch;
+}
+declare class AgentApiError extends Error {
+    readonly status: number;
+    readonly body: AgentApiErrorBody | undefined;
+    constructor(status: number, body: AgentApiErrorBody | undefined, message: string);
+}
+declare class AgentClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    constructor(options: AgentClientOptions);
+    /** GET /api/agent/kb/search — requires the `kb:read` scope. */
+    searchKb(params: SearchKbParams): Promise<KbSearchResponse>;
+    /** GET /api/agent/faq — requires the `faq:read` scope. */
+    getFaq(): Promise<unknown>;
+    /** GET /api/agent/tickets — requires the `tickets:read` scope. */
+    getTickets(params?: GetTicketsParams): Promise<GetTicketsResponse>;
+    /** POST /api/agent/tickets — requires the `tickets:write` scope. */
+    createTicket(params: CreateTicketParams): Promise<Ticket>;
+    /** POST /api/agent/answers — requires the `answers:write` scope. */
+    generateAnswer(params: GenerateAnswerParams): Promise<GenerateAnswerResponse>;
+    private request;
+}
+
+export { AgentApiError, type AgentApiErrorBody, AgentClient, type AgentClientOptions, type CreateTicketParams, type GenerateAnswerParams, type GenerateAnswerResponse, type GetTicketsParams, type GetTicketsResponse, type KbSearchResponse, type KbSearchResult, type SearchKbParams, type Ticket, type TicketCategory, type TicketPriority, type TicketStatus };

package/dist/index.d.ts

@@ -0,0 +1,95 @@
+interface KbSearchResult {
+    question: string;
+    answer: string;
+    score: number;
+}
+interface KbSearchResponse {
+    results: KbSearchResult[];
+}
+type TicketStatus = "open" | "in_progress" | "resolved" | "closed";
+type TicketPriority = "critical" | "high" | "medium" | "low";
+type TicketCategory = "bug" | "feature_request" | "documentation" | "how_to" | "general_question";
+interface Ticket {
+    id: number;
+    content: string;
+    category: TicketCategory | null;
+    priority: string;
+    status: string;
+    ai_summary: string | null;
+    created_at: string;
+}
+interface GetTicketsParams {
+    status?: TicketStatus;
+    priority?: TicketPriority;
+    category?: TicketCategory;
+    /** 1-20, defaults to 10 */
+    limit?: number;
+}
+interface GetTicketsResponse {
+    tickets: Ticket[];
+}
+interface CreateTicketParams {
+    /** The user's question or issue, verbatim. Max 4000 characters. */
+    content: string;
+    /** Name/identifier of the end user this ticket is on behalf of. */
+    authorName?: string;
+    /** Retrying with the same key returns the original ticket instead of opening a duplicate. */
+    idempotencyKey?: string;
+}
+interface GenerateAnswerParams {
+    /** Max 2000 characters. */
+    question: string;
+}
+interface GenerateAnswerResponse {
+    answer: string;
+    confidence: number;
+    answered_fully: boolean;
+    high_confidence: boolean;
+}
+interface SearchKbParams {
+    /** Max 2000 characters. */
+    query: string;
+    /** 1-20, defaults to 5 */
+    limit?: number;
+}
+/** Shape of the `Error` schema returned on 400/401/403/429 responses. */
+interface AgentApiErrorBody {
+    error: string;
+    [key: string]: unknown;
+}
+
+interface AgentClientOptions {
+    /** API key from Settings -> API Keys, `al_live_...`. Shared with the MCP server. */
+    apiKey: string;
+    /**
+     * Base URL of the answerLoops instance. Defaults to the hosted cloud
+     * (`https://answerloops.com`). Point this at a self-hosted instance instead.
+     */
+    baseUrl?: string;
+    /** Overrides the global `fetch` — mainly for tests. */
+    fetch?: typeof fetch;
+}
+declare class AgentApiError extends Error {
+    readonly status: number;
+    readonly body: AgentApiErrorBody | undefined;
+    constructor(status: number, body: AgentApiErrorBody | undefined, message: string);
+}
+declare class AgentClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly fetchImpl;
+    constructor(options: AgentClientOptions);
+    /** GET /api/agent/kb/search — requires the `kb:read` scope. */
+    searchKb(params: SearchKbParams): Promise<KbSearchResponse>;
+    /** GET /api/agent/faq — requires the `faq:read` scope. */
+    getFaq(): Promise<unknown>;
+    /** GET /api/agent/tickets — requires the `tickets:read` scope. */
+    getTickets(params?: GetTicketsParams): Promise<GetTicketsResponse>;
+    /** POST /api/agent/tickets — requires the `tickets:write` scope. */
+    createTicket(params: CreateTicketParams): Promise<Ticket>;
+    /** POST /api/agent/answers — requires the `answers:write` scope. */
+    generateAnswer(params: GenerateAnswerParams): Promise<GenerateAnswerResponse>;
+    private request;
+}
+
+export { AgentApiError, type AgentApiErrorBody, AgentClient, type AgentClientOptions, type CreateTicketParams, type GenerateAnswerParams, type GenerateAnswerResponse, type GetTicketsParams, type GetTicketsResponse, type KbSearchResponse, type KbSearchResult, type SearchKbParams, type Ticket, type TicketCategory, type TicketPriority, type TicketStatus };

package/dist/index.js

@@ -0,0 +1,81 @@
+// src/client.ts
+var AgentApiError = class extends Error {
+  status;
+  body;
+  constructor(status, body, message) {
+    super(message);
+    this.name = "AgentApiError";
+    this.status = status;
+    this.body = body;
+  }
+};
+var DEFAULT_BASE_URL = "https://answerloops.com";
+var AgentClient = class {
+  apiKey;
+  baseUrl;
+  fetchImpl;
+  constructor(options) {
+    if (!options.apiKey) {
+      throw new Error("AgentClient requires an apiKey (Settings -> API Keys).");
+    }
+    this.apiKey = options.apiKey;
+    this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this.fetchImpl = options.fetch ?? fetch;
+  }
+  /** GET /api/agent/kb/search — requires the `kb:read` scope. */
+  searchKb(params) {
+    const query = new URLSearchParams({ query: params.query });
+    if (params.limit !== void 0) query.set("limit", String(params.limit));
+    return this.request("GET", `/api/agent/kb/search?${query}`);
+  }
+  /** GET /api/agent/faq — requires the `faq:read` scope. */
+  getFaq() {
+    return this.request("GET", "/api/agent/faq");
+  }
+  /** GET /api/agent/tickets — requires the `tickets:read` scope. */
+  getTickets(params = {}) {
+    const query = new URLSearchParams();
+    if (params.status) query.set("status", params.status);
+    if (params.priority) query.set("priority", params.priority);
+    if (params.category) query.set("category", params.category);
+    if (params.limit !== void 0) query.set("limit", String(params.limit));
+    const qs = query.toString();
+    return this.request("GET", `/api/agent/tickets${qs ? `?${qs}` : ""}`);
+  }
+  /** POST /api/agent/tickets — requires the `tickets:write` scope. */
+  createTicket(params) {
+    return this.request("POST", "/api/agent/tickets", {
+      content: params.content,
+      authorName: params.authorName,
+      idempotencyKey: params.idempotencyKey
+    });
+  }
+  /** POST /api/agent/answers — requires the `answers:write` scope. */
+  generateAnswer(params) {
+    return this.request("POST", "/api/agent/answers", { question: params.question });
+  }
+  async request(method, path, body) {
+    const res = await this.fetchImpl(`${this.baseUrl}${path}`, {
+      method,
+      headers: {
+        Authorization: `Bearer ${this.apiKey}`,
+        ...body ? { "Content-Type": "application/json" } : {}
+      },
+      body: body ? JSON.stringify(body) : void 0
+    });
+    const text = await res.text();
+    const data = text ? JSON.parse(text) : void 0;
+    if (!res.ok) {
+      throw new AgentApiError(
+        res.status,
+        data,
+        data?.error ?? `Agent API request failed: ${res.status}`
+      );
+    }
+    return data;
+  }
+};
+export {
+  AgentApiError,
+  AgentClient
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@answerloops/agent-sdk",
+  "version": "0.1.0",
+  "description": "Typed client for the answerLoops Agent API (knowledge base search, FAQ, tickets, grounded answers).",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/answerLoops/answerLoops.git",
+    "directory": "packages/agent-sdk"
+  },
+  "homepage": "https://answerloops.com/docs/integrations/agent-api",
+  "bugs": "https://github.com/answerLoops/answerLoops/issues",
+  "keywords": [
+    "answerloops",
+    "agent-api",
+    "mcp",
+    "support",
+    "knowledge-base"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts --clean",
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.3"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}