DocsGetting Started

Quick Start Guide

Start with API keys, then use the SDK or direct API calls. Open the reference page for complete method and query documentation.

01 / AUTH

API Keys

Create, scope, rotate, and revoke workspace API keys for secure integrations.

02 / SDK

SDK

Use @layerum-team/rag-sdk for entities, uploads, ingestion wait, and query workflows.

03 / API

API

Explore public /v1 endpoints, capabilities, scopes, and request/response behavior.

Installation

Install the official SDK package from npm.

Bash

npm i @layerum-team/rag-sdk

Initialize the Client

Initialize LayerumClient with your workspace API key.

Node.js

import { LayerumClient } from '@layerum-team/rag-sdk';

const client = new LayerumClient({
  apiKey: process.env.LAYERUM_API_KEY!, // lyr_wk_...
  baseUrl: 'https://api.layerum.com'
});

Need a sandbox?

Try our interactive playground to test API calls in real-time without writing a single line of local code.

Open Playground

Read the Concepts

Understand the underlying architecture of Layerum and how we handle high-density data vectors.

Core Concepts