JavaScript SDK reference

Item	Value
npm package	`@surrealdb/spectron`
Source	`spectron/clients/typescript/`
OpenAPI input	`doc/spec/*.swagger.json`

Install

npm install @surrealdb/spectron

Configuration

import { createSpectronClient } from "@surrealdb/spectron";

const client = createSpectronClient({
  baseUrl: process.env.SPECTRON_URL!,
  apiKey: process.env.SPECTRON_API_KEY!,
  contextId: process.env.SPECTRON_CONTEXT_ID!,
});

Uses API-KEY header authentication (not Authorization: Bearer).

Core operations

Same REST mapping as Python; see the REST API.

Harness adapter

npm install @surrealdb/spectron-vercel-ai

→ Vercel AI SDK

User guide

→ JavaScript and TypeScript SDK