API reference

import { Spine } from 'spine-sdk';

const client = new Spine({
  apiKey,                // string — required, falls back to none (no env-var auto-load)
  baseURL,               // string — defaults to "https://api.getspine.ai"
  timeoutMs,             // number — per-request timeout, default 60_000
  maxRetries,            // number — transient-failure retries, default 2
  fetch,                 // typeof fetch — inject a custom implementation
  onRequest,             // hook — fires before each request
  onResponse,            // hook — fires after each response
});

{
  prompt: string;
  template?: Template;
  blocks?: BlockType[];
  agent_instructions?: string;
  webhook_url?: string;
  files?: FileInput[];
}

{
  pollIntervalMs?: number;   // default: 5000
  timeoutMs?: number;        // default: 900_000
  signal?: AbortSignal;
  resolveOnFailure?: boolean; // default: false
}

type Run = RunningRun | CompletedRun | PartialRun | FailedRun;
type TerminalRun = CompletedRun | PartialRun | FailedRun;

import type {
  // Run types
  Run, TerminalRun, RunningRun, CompletedRun, PartialRun, FailedRun, RunEcho,
  // Core types
  RunProgress, RunResult, RunMetadata, RunErrorEntry, Artifact,
  Block, Edge, Canvas, Task, TaskTree,
  // Options
  SpineOptions, CreateRunParams, CreatedRun, WaitForCompletionOptions, FileInput,
  // Hooks
  FetchLike, OnRequestHook, OnResponseHook,
} from 'spine-sdk';

import {
  SpineError,                // base
  SpineAPIError,
  SpineBadRequestError,      // 400
  SpineAuthError,            // 401
  SpineNotFoundError,        // 404
  SpineServerError,          // 5xx
  SpineConnectionError,
  SpineTimeoutError,
  SpineRunFailedError,
} from 'spine-sdk';

import { downloadArtifact, isUuid, VERSION } from 'spine-sdk';

// Fetch an artifact as a Blob.
const blob = await downloadArtifact(artifact, { signal });

// Client-side UUID validation (same rule the SDK applies before any HTTP call).
isUuid('550e8400-e29b-41d4-a716-446655440000'); // true

// Published SDK version string.
console.log(VERSION);