> Documentation index for agents: https://docs.rocketride.ai/llms.txt

# TypeScript SDK

Build, run, and manage AI pipelines from Node.js or the browser. The `rocketride`
package ships complete type definitions and speaks the engine's native
[WebSocket protocol](/connect/websocket): you author a `.pipe`
([visually](/clients/vscode) or [by hand](/reference/pipeline-reference)) and run it
against the engine from your own application.

## Install

```bash
npm install rocketride    # or: yarn add rocketride / pnpm add rocketride
```

The [`rocketride` CLI](/connect/cli) is installed with the package.

## Quickstart

```typescript
import { RocketRideClient } from 'rocketride';

const client = new RocketRideClient({
	auth: process.env.ROCKETRIDE_APIKEY!,
	uri: 'https://api.rocketride.ai',
});
await client.connect();
const { token } = await client.use({ filepath: './pipeline.pipe' });
const result = await client.send(token, 'Hello, pipeline!', { name: 'input.txt' }, 'text/plain');
console.log(result);
await client.terminate(token);
await client.disconnect();
```

`send()` / `sendFiles()` target pipelines whose **source** is `webhook` or
`dropper`; if your pipeline source is `chat`, use
[`client.chat()`](/clients/typescript/chat). No pipeline yet? The
[IDE walkthrough](/quickstart/ide-walkthrough) builds one in minutes.

## Explore the SDK

- [Configuration](/clients/typescript/configuration/): Client config, environment variables, timeouts, and reconnection.

- [Connection](/clients/typescript/connection/): The attach/login layers, persist mode, concurrent-login semantics, and callbacks.

- [Running Pipelines](/clients/typescript/pipelines/): Start with use(), watch progress, validate, and terminate.

- [Deployments](/clients/typescript/deploy/): Publish immutable versions, point team environments at them, and schedule runs.

- [Sending Data](/clients/typescript/data/): One-shot sends, concurrent file uploads with progress, and chunked streaming.

- [File Storage](/clients/typescript/storage/): Read, write, and manage your server-side store; signed URLs for direct access.

- [Chat](/clients/typescript/chat/): Build a Question, stream the response, parse it with Answer.

- [Run Logs](/clients/typescript/logs/): The log continuum and the DVR session: live monitoring and replay with one API.

- [Error Handling](/clients/typescript/errors/): What the SDK throws, when, and how to catch it.

- [API Reference](/clients/typescript/reference/): Every public class and method, in one place.

- [Examples](/clients/typescript/examples/): Seven complete programs, from hello-pipeline to custom DAP requests.

- [Drizzle over Pipelines](/clients/typescript/database-drizzle/): A Drizzle ORM driver whose SQL rides a pipeline instead of a TCP socket.

- [Sequelize over Pipelines](/clients/typescript/database-sequelize/): A Sequelize ORM whose SQL rides a pipeline instead of a TCP socket.

- [Analytics](/clients/typescript/analytics/): Report client-side analytics events through the SDK.

## Links

- [GitHub](https://github.com/rocketride-org/rocketride-server) · [npm](https://www.npmjs.com/package/rocketride) · [Discord](https://discord.gg/PMXrtenMsY)
- [Release notes](/support/release-notes) · [Get help](/support/get-help)
