Orvelt
Getting started

Get started with the Business API

Install the TypeScript SDK and make an authenticated Business API request.

Build a working server-side integration in three steps:

  1. Install the SDK.
  2. Configure an API key.
  3. Send your first request.

You need a Business workspace, a project ID, and an API key for the project's organization. The SDK uses https://api.orvelt.com/v1 by default.

Install @orvelt/business

Add the generated client to a Bun, Node.js, or TypeScript service.

Send your first request

List a project's research goals and inspect the typed response.

Understand authentication

Learn how key scope, headers, and permissions work.

Overview

Build server-side integrations with the Orvelt Business API and TypeScript SDK.

Install the TypeScript SDK

Add the generated @orvelt/business client to your server application.