Skip to main content

TypeScript SDK

View as Markdown

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: you author a .pipe (visually or by hand) and run it against the engine from your own application.

Install​

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

The rocketride CLI is installed with the package.

Quickstart​

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(). No pipeline yet? The IDE walkthrough builds one in minutes.

Explore the SDK​

ConfigurationClient config, environment variables, timeouts, and reconnection.ConnectionThe attach/login layers, persist mode, concurrent-login semantics, and callbacks.Running PipelinesStart with use(), watch progress, validate, and terminate.DeploymentsPublish immutable versions, point team environments at them, and schedule runs.Sending DataOne-shot sends, concurrent file uploads with progress, and chunked streaming.File StorageRead, write, and manage your server-side store; signed URLs for direct access.ChatBuild a Question, stream the response, parse it with Answer.Run LogsThe log continuum and the DVR session: live monitoring and replay with one API.Error HandlingWhat the SDK throws, when, and how to catch it.API ReferenceEvery public class and method, in one place.ExamplesSeven complete programs, from hello-pipeline to custom DAP requests.Sequelize over PipelinesA Sequelize ORM whose SQL rides a pipeline instead of a TCP socket.AnalyticsReport client-side analytics events through the SDK.
Last updated on