Installation

Roset provides an official TypeScript SDK plus direct REST API access for any HTTP client. The SDK handles authentication, request formatting, and typed responses so you can focus on your application logic.

TypeScript SDK (Recommended)#

Install the SDK with npm, pnpm, or yarn:

npm install @roset/sdk

Requires Node.js 18 or later. Also works in edge runtimes (Cloudflare Workers, Deno, Bun).

Verify the Installation#

import { RosetClient } from '@roset/sdk';
 
// Initialize with your API key
const client = new RosetClient({ apiKey: 'rsk_...' });
console.log('Connected to Roset');

Environment Setup#

Store your API key as an environment variable instead of hardcoding it:

export ROSET_API_KEY=rsk_your_key_here

Then reference it in your code:

import { RosetClient } from '@roset/sdk';
 
// Read the API key from the environment
const client = new RosetClient({
  apiKey: process.env.ROSET_API_KEY!,
});

Provider Keys#

Roset orchestrates extraction providers on your behalf. All tiers include managed extraction keys. BYOK is available on Growth+ plans for a 40% discount on overage rates.

You can optionally add your own provider keys in the console under Settings > Provider Keys:

• Reducto -- document extraction (PDF, DOCX, PPTX)
• OpenAI -- vector embeddings
• Gemini -- image processing
• Whisper -- audio transcription

You can also manage provider keys through the API. See PUT /v1/org/provider-keys for details.

Direct API Access#

If you prefer not to use an SDK, all endpoints are accessible with any HTTP client. Roset is a standard REST API:

# List your files
curl https://api.roset.dev/v1/files \
  -H "Authorization: ApiKey rsk_your_key"

See Authentication for details on supported auth methods.