Niravi Cloud API

Search, recall, and analyze a library of video, photos and documents over a simple HTTP API, with a TypeScript SDK and an MCP server for Claude.

Everything is one base URL, https://api.niravi.io, and one credential, an API key (nv_…). A key works in its home workspace and any others you grant it (Concepts).

New (2026-10-14): images & documents, object regions, library-wide People, and an Arrow-only feature set. The older NiNo pipelines and NiQu (classic) search are deprecated.

1. Get an API key

Create one in the dashboard → Settings → Developer. Pick the scopes (read and/or write) and an optional expiry. The secret is shown once — store it somewhere safe.

2. Make your first call

curl https://api.niravi.io/api/v1/search \
  -H "X-API-Key: $NIRAVI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "a person walking at sunset", "engine": "arrow", "limit": 5}'

Every response is a typed envelope — { "success": true, "data": … } on success, { "success": false, "error": { code, message, status } } on failure.

3. Or use the SDK

// npm install @niravi/sdk
import { connect } from "@niravi/sdk";
const niravi = connect("nv_...");
const hits = await niravi.search("a person walking at sunset", { limit: 5 });

The Python SDK is on its way to PyPI; until then, call the HTTP API from Python (any HTTP client works).

Where to next

ConceptsKeys & scopes, workspaces, pagination, errors, rate limits. SearchSemantic search + typed "magic" search by character, location, music, emotion. Recall & ChatAsk natural-language questions grounded in your video. Images & documentsPhotos, PDFs and decks: hits land on the page, the passage and the box. PeopleFaces grouped into people across your whole library. Indexing & enginesChoose the stages per upload or workspace; Arrow vs the deprecated engines. ChangelogWhat changed, and what is deprecated. SDKsTypeScript (Python soon), generated from the same OpenAPI spec. MCP for ClaudeExpose your corpus to Claude as tools. API ReferenceEvery endpoint, grouped, with try-it.

Demo without a key? The interactive API Reference lets you browse every endpoint and its schemas. To run live calls you’ll need a key.