Client Libraries, Apps SDK & OpenAPI

Client libraries for consuming the RLVNCE API, an Apps SDK for building custom connectors and rankers, and an OpenAPI spec for code generation in any language.

Two kinds of integration

Client libraries vs Apps SDK

Client libraries

Connect to the RLVNCE API to consume the service - search corpora, fetch documents, manage sources, subscribe to changes. Typed wrappers around the REST API for your language of choice.

Apps SDK coming soon

Build extension apps that run on the RLVNCE platform - custom connectors for specialized data sources and custom rankers for domain-specific relevance logic. Deploy as private or marketplace apps.

TypeScript client

Full type safety, async/await, zero runtime dependencies. Node.js 18+. GitHub →

search.ts

// Install

npm install @rlvnce/client

// Usage

import { RlvnceClient } from '@rlvnce/client';

const client = new RlvnceClient({ apiKey: 'your-api-key' });

const results = await client.search('corpus-id', {
  query: 'cybersecurity risk',
  filters: { form_type: '10-K' },
  limit: 10,
});

Python client coming soon

Pythonic interface with async support

search.py

# Install (coming soon)

pip install rlvnce

# Usage

from rlvnce import Rlvnce

client = Rlvnce(api_key="your-api-key")

results = client.search("corpus-id",
    query="cybersecurity risk",
    filters={"form_type": "10-K"},
    limit=10,
)

Apps SDK coming soon

Build custom connectors and rankers that run on the RLVNCE platform

Custom connectors

Build connectors for data sources that need API access, authentication, or specialized extraction logic. Define a manifest, configuration schema, and fetch/extract methods. Deploy as a private app for your organization or publish to the marketplace.

Custom rankers

Build rankers that add domain-specific scoring, ML reranking, or cross-document deduplication logic. Rankers receive search results and return reordered/filtered results. Run as apps alongside the default BM25F ranking pipeline.

OpenAPI Spec

Generate clients in any language

The full API is described by an OpenAPI 3.1 spec. Use it with any code generator to produce clients in Go, Java, Ruby, or any other language.

Available at https://app.rlvnce.com/api/v1/openapi.json

Authentication

Secure API key management

API keys

Create API keys in the dashboard. Each key is shown once on creation - store it securely. Keys are hashed (SHA-256) and never stored in plaintext.

Scoped permissions

Restrict keys to specific corpora and operations. Set expiration dates. Rotate keys regularly and revoke immediately if compromised.

Start integrating

Install the TypeScript client and run your first search in minutes.

Get your API key