TypeScript SDK

@elanotes/sdk is packaging of the HTTP contract, not a new surface. Types come from openapi-typescript over contracts/openapi/elanotes.v1.json. The client is openapi-fetch. Workspace-only. Not published to npm. Package path: packages/sdk. Browser-safe: no Node-only modules. Read the bearer from ELA_API_TOKEN. Create a personal access token in web Settings → Access tokens. Read is included; authenticated note mutations require notes.write. Permissions are enforced through the SDK just as through HTTP, CLI, and Cloud MCP.

pnpm --filter @elanotes/sdk build

Create a client

import { createElanotesClient, ElanotesError } from "@elanotes/sdk";

const client = createElanotesClient({
  baseUrl: "https://api.elanotes.com",
  token: process.env.ELA_API_TOKEN,
});

const { data } = await client.GET("/v1/search", {
  params: { query: { q: "Paddle" } },
});

baseUrl is the API origin (no /v1 suffix). A local API uses baseUrl: "http://127.0.0.1:4000". Send the bearer in token. Writes get an automatic Idempotency-Key (UUID) unless you set one. Failed responses throw ElanotesError with reason, hint, help, retryAfterSeconds, and details. Check write receipts before reading applied-only fields:

const { data: receipt } = await client.POST("/v1/notes", {
  body: {
    path: "agents/sdk-demo.md",
    content: "# SDK demo\n",
    agent_id: "sdk",
  },
});
if (receipt?.status === "queued") {
  console.log("Pending human review:", receipt.pending_id);
} else if (receipt?.status === "applied") {
  console.log(receipt.version_id, receipt.committed_seq);
}

A queued write has not changed the note. Receipt inspection also requires notes.review when authenticated. With a write-only token, hand the ID to a reviewer; agents must not approve their own proposals.

VERSION_MOVED

try {
  await client.POST("/v1/notes/{note}:edit", {
    params: { path: { note: "hello" } },
    body: {
      version_id: stale,
      old_string: "Hello",
      new_string: "Hello again",
      agent_id: "sdk",
    },
  });
} catch (err) {
  if (err instanceof ElanotesError && err.reason === "VERSION_MOVED") {
    console.error(err.hint);
  }
}

Regenerate after an OpenAPI change: node scripts/sdk-generate.mjs. Drift check: node scripts/assert-sdk-current.mjs (wired into pnpm verify). The Python SDK is generated from the same spec.

Get started

Connect

Using Ela

API reference

TypeScript SDK

Create a client

VERSION_MOVED