Registry / ai-ml / revai-node-sdk

revai-node-sdk

library3.8.5jsnpmunverified

Official Node.js SDK for the Rev AI speech-to-text API, enabling automatic speech recognition with features like async transcription, custom vocabulary, speaker diarization, language selection, summarization, and translation. Current stable version is 3.8.5, released under a regular cadence. Key differentiators include support for multiple input types (local files, URLs, audio streams), human transcription option, global deployment configuration, and full TypeScript typings. The SDK wraps Rev AI's REST API for job submission and retrieval.

ai-ml llm-agents http-networking

npm install revai-node-sdk

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · REVAI-NODE-SDK

revai-node-sdk

ai-mljavascriptv3.8.5

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

RevAiApiClient

✓ import { RevAiApiClient } from 'revai-node-sdk'

✗ const { RevAiApiClient } = require('revai-node-sdk')

Library is ESM-first; require() fails in Node <12 or without esModuleInterop. From v3, CommonJS interop is not provided.

RevAiApiDeploymentConfigMap

✓ import { RevAiApiDeploymentConfigMap } from 'revai-node-sdk'

✗ import RevAiApiDeploymentConfigMap from 'revai-node-sdk'

Must use named import; default export is undefined.

RevAiApiDeployment

✓ import { RevAiApiDeployment } from 'revai-node-sdk'

✗ import * as RevAiApiDeployment from 'revai-node-sdk/RevAiApiDeployment'

Enum is exported from main module; subpath imports are not supported.

Initializes a Rev AI client with an access token, submits a local audio file for transcription, and retrieves the result.

import { RevAiApiClient, RevAiApiDeployment, RevAiApiDeploymentConfigMap } from 'revai-node-sdk'; const accessToken = process.env.REVAI_ACCESS_TOKEN ?? ''; const client = new RevAiApiClient({ token: accessToken, deploymentConfig: RevAiApiDeploymentConfigMap.get(RevAiApiDeployment.US) }); async function main() { const account = await client.getAccount(); console.log('Account balance:', account.balance); const job = await client.submitJobLocalFile('./audio.mp3', { language: 'en' }); console.log('Job ID:', job.id); const transcript = await client.getTranscriptObject(job.id); console.log('Transcript:', transcript.monologues[0].elements[0].value); } main().catch(console.error);

Debug

Known issues

breakingIn v3, the client constructor no longer accepts only a token string; it requires an object with `token` and optional `deploymentConfig`.

fix

Change `new RevAiApiClient(token)` to `new RevAiApiClient({ token })`. Provide deployment config if needed.

affects: >=3.0.0

deprecatedThe method `getTranscriptText` returns raw text; use `getTranscriptObject` for structured data.

fix

Use `getTranscriptObject(jobId)` and access structured fields.

affects: <=2.x

gotchaSubmitJobLocalFile expects the file path as first argument; do not pass a stream or Buffer directly.

fix

Use `submitJobAudioData(stream, filename)` for streams.

affects: *

gotchaThe `source_config` object in job options must contain a `url` key for remote files; omitting it causes silent failure.

fix

Always include `source_config: { url: '...' }` when using `submitJob` with a URL.

affects: *

deprecatedNode 8, 10 are no longer tested; support was dropped in v3.5.0.

fix

Use Node 12 or later, preferably 16 or 18.

affects: >=3.5.0

Errors

Common errors & fixes

SyntaxError: Cannot use import statement outside a module

Using ES import syntax in a CommonJS project without ESM enabled.

fix

Set `"type": "module"` in package.json, or use dynamic import: `const { RevAiApiClient } = await import('revai-node-sdk')`.

TypeError: RevAiApiClient is not a constructor

Using default import instead of named import.

fix

Use `import { RevAiApiClient } from 'revai-node-sdk'` instead of `import RevAiApiClient from 'revai-node-sdk'`.

Error: "deploymentConfig" is required but not specified

Client initialized without a deployment configuration.

fix

Provide `deploymentConfig: RevAiApiDeploymentConfigMap.get(RevAiApiDeployment.US)` or other deployment.

Error: No account found with the given access token

Access token is invalid, expired, or missing.

fix

Check the access token on your Rev AI settings page and ensure it is correctly passed to the client.

Upgrade

Version history

3.8.5latest on npm

Audit

Dependencies

tslibrequiredRuntime dependency for TypeScript helpers when consuming as compiled JS.

Agent activity

27 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/revdotcom/revai-node-sdk ↗

packagehttps://www.npmjs.com/package/revai-node-sdk ↗

homepagehttps://www.rev.ai ↗