TypeScript SDK

@vly/sdk — full type safety, streaming support, automatic retries, and OpenAPI-generated types.

The official TypeScript / JavaScript SDK. Full type safety from the OpenAPI spec, async iterators for pagination, automatic retry on transient errors.

Install

npm

npm install @vly/sdk

Quick start

import { Vly } from "@vly/sdk";

const vly = new Vly({ apiKey: process.env.VLY_API_KEY! });

// List projects
const { data: projects } = await vly.projects.list({ limit: 20 });

// Create a project
const project = await vly.projects.create({
  name:   "Tasks for teams",
  prompt: "A real-time task tracker...",
  agent:  "claude-code",
});

// Trigger an agent run
const run = await vly.agents.run({
  projectId: project.id,
  prompt:    "Add a settings page",
});

// Stream output
for await (const chunk of run.stream()) {
  console.log(chunk);
}

Async iteration

for await (const project of vly.projects.iterate({ limit: 100 })) {
  console.log(project.name);
}

Handles pagination internally.

Error handling

import { VlyError } from "@vly/sdk";

try {
  await vly.projects.create({ /* ... */ });
} catch (err) {
  if (err instanceof VlyError) {
    console.log(err.code, err.message);
    if (err.code === "key_rate_limited") {
      // wait and retry
    }
  }
}

Configuration

const vly = new Vly({
  apiKey:   process.env.VLY_API_KEY!,
  baseUrl:  "https://api.vly.ai",     // override for staging
  timeout:  30_000,                    // request timeout (ms)
  maxRetries: 3,                       // automatic retries on 429/5xx
});

Related

Python SDK

Same surface, Python.

CLI

Same API, terminal.

Webhooks SDK

Webhook signature verification helpers.