Niravi Docs
npm ↗ Get a key ↗

Changelog & deprecations

Deprecations

Deprecated features keep working; they get no new capabilities. A removal date will be announced on this page before anything is turned off.

DeprecatedSinceUse insteadToday
NiNo tiers on upload: pipeline=lite, pro, max, nino_lite, nino_pro, nino_max (and older engine names)2026-10-14pipeline=arrowStill accepted for videos. No pages, regions, People or index options
nino_tier on GET /videos/{id}2026-10-14index.options and index.reportStill returned; null for Arrow assets
NiQu search: "engine": "classic"2026-10-14"engine": "arrow"Still answers for libraries indexed by NiNo, and is still their default engine. GET /engines shows its status as deprecated

Moving to Arrow. New uploads: send pipeline=arrow and search with "engine": "arrow". Arrow searches only what Arrow indexed, so for an existing library, re-upload with pipeline=arrow, or write to [email protected] and we will re-index it for you.

2026-10-14

Images & documents. Upload photos, PDFs, decks, Office and text files with the same POST /videos; the response says kind (video / image / document). Video detail gains kind and page_count. → Images & documents

  • GET /videos/{id}/pages/{page}: a document page’s text, passages with boxes, render and regions.
  • GET /videos/{id}/regions: every object, face and text box on an asset, normalized top-left.
  • Search hits (engine: arrow) gain asset_kind, page, passage and region.

Objects. A new objects stage boxes everyday things plus logos, signs, screens, flags, charts, diagrams, maps, posters and helmets, and your own vocabulary. → Indexing

People. Faces (now open-source models, on by default) are grouped into people across the whole workspace: GET /people, GET /people/{id}, rename / hide / cover with PATCH, merge, remove, recluster. → People

Delete purges. DELETE /videos/{id} is owner-only (403 for an asset shared into your workspace), hides the asset at once and purges it in the background: search indexes, pages, regions, faces and stored files, with People refreshed. The response adds "purging": true.

Deprecated: NiNo tiers, nino_tier and the NiQu (classic) engine. See Deprecations.

2026-10-13

Index options. Choose stages per upload (options form field) or per workspace (GET / PUT /index-options): transcript language, speakers, sounds, labels, OCR languages (English, Hindi), faces. Each video’s run is reported in index.report. → Indexing

2026-10-12

Engines. POST /search takes "engine": "arrow" | "classic"; GET /engines lists the engines and your default. The response says which engine answered (engine, recipe) and why another one did (engine_fallback).

2026-06-22

Workspaces. Per-key workspace access lists, GET /workspaces, X-Workspace-Id, read-only demo workspaces, and federated search with workspace_ids (each hit tagged with its workspace_id). → Concepts

MCP & SDKs. The TypeScript SDK and the MCP server on npm (@niravi/sdk, @niravi/mcp), and the remote MCP at mcp.niravi.io for Claude. → MCP

2026-06-17

API keys. Self-service keys with scopes and expiry in the dashboard, per-key usage, nv_ keys accepted as X-API-Key or Authorization: Bearer. → Concepts