API Reference / Introduction

Introduction

The Neutron API provides powerful document processing and semantic search capabilities. Upload documents, perform vector searches, and organize content with intelligent bundles. Built on Jina Embeddings v4 for multimodal search across text and images.

Base API URL

https://api-neutron.vanarchain.com

Authentication

Include your API key in the Authorization header using the Bearer scheme:

Authorization: Bearer YOUR_API_KEY

Security: Never expose API keys in client-side code. Always make API calls from your backend server.

Required Parameters

All authenticated requests require these parameters:

ParameterLocationTypeDescription
AuthorizationHeaderstringRequired Bearer token with your API key
appIdQuerystringRequired Application identifier for tenant isolation
externalUserIdQuerystringRequired External user identifier (not required for stats)

Note: All endpoints use query parameters for appId and externalUserId, including POST endpoints.

Multi-Tenant Architecture

Neutron supports multi-tenancy at three levels:

Organization

Top-level tenant namespace (automatically derived from API key)

Application

App grouping within organization (via appId parameter)

External User

User identifier for data isolation (via externalUserId parameter)

Note: For read operations (GET), you can pass arrays to query across multiple contexts. For write operations, only single values are accepted.

Next Steps