Introduction

Welcome to Moorcheh API

The Moorcheh API provides powerful vector and text search capabilities through a simple and intuitive REST API. Our API allows you to create namespaces, upload text or vector data, and perform semantic searches with high accuracy and low latency.

Base URL

All API endpoints are accessible at:

https://api.moorcheh.ai/v1

Authentication

The Moorcheh API uses API key authentication. You must include your API key in the x-api-key header with every request.

The header name is x-api-key (all lowercase).

Request/Response Naming

Use snake_case for request and response fields (for example: top_k, kiosk_mode, namespace_name). Legacy camelCase aliases are not supported as of platform version 1.5.10 (May 2026). Update any clients still using camelCase keys.

Get Your API Key

Create your account at console.moorcheh.ai

Generate API Key

Navigate to the API Keys section and generate a new key

Store Securely

Copy and securely store your API key

Authentication Header

x-api-key: your-api-key-here

Example Request

curl -X GET "https://api.moorcheh.ai/v1/namespaces" \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json"

import requests

headers = {
    'x-api-key': 'your-api-key-here',
    'Content-Type': 'application/json'
}

response = requests.get(
    'https://api.moorcheh.ai/v1/namespaces',
    headers=headers
)

const headers = {
  'x-api-key': 'your-api-key-here',
  'Content-Type': 'application/json'
};

fetch('https://api.moorcheh.ai/v1/namespaces', {
  method: 'GET',
  headers: headers
});

API Endpoints

Namespace Management

Create, list, and delete namespaces

Search & Discovery

Perform semantic search across namespaces

AI Generation

Generate AI-powered answers from your data

Data Operations

Upload and manage text or vector data

Basic Workflow

Authenticate

Include your API key in the x-api-key header

Create a Namespace

Create a namespace to organize your data (text or vector type)

Upload Data

Upload text documents or vector embeddings to your namespace

Perform semantic search to retrieve relevant data

Generate Answers

Use AI models to generate contextual answers from your data

Error Responses

The API uses standard HTTP status codes:

Status Code	Meaning	Description
200	OK	Request succeeded
201	Created	Resource created successfully
202	Accepted	Request accepted for processing
400	Bad Request	Invalid request parameters
401	Unauthorized	Invalid or missing API key
403	Forbidden	Insufficient permissions
404	Not Found	Resource not found
409	Conflict	Resource already exists
413	Payload Too Large	File exceeds size limit (10MB)
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Server-side error

Error Response Format

{
  "error": "Error description",
  "message": "Detailed error message"
}

Security Best Practices

Store API Keys Securely

Use environment variables instead of hardcoding
Never commit API keys to version control
Use secret management services in production

# Good: Use environment variables
export MOORCHEH_API_KEY="your-api-key"

Use HTTPS Only

All API requests must use HTTPS. HTTP requests will be rejected.

Rotate Keys Regularly

Generate new API keys periodically
Revoke old keys after rotation
Monitor key usage in your console

Implement Rate Limiting

Add exponential backoff for retries
Monitor API usage
Implement client-side throttling

Validate Inputs

Sanitize user inputs before searching
Validate metadata formats
Check file types before upload

Rate Limits

API keys are subject to rate limiting based on your subscription tier. If you exceed your rate limit, you’ll receive a 429 Too Many Requests response.

Contact support@moorcheh.ai for information about rate limits and enterprise plans.

SDKs and Integrations

Python SDK

Official Python SDK with full API coverage

LangChain

Vector store integration for LangChain

LlamaIndex

Native LlamaIndex vector store support

MCP Server

Model Context Protocol integration

Chat Boilerplate

Ready-to-use chat application

Need Help?

Quick Start

Get started in 5 minutes

Guides

Learn core concepts

Support

Contact our team

GitHub

View open-source SDKs

Getting Started

Namespace Management

Search & Discovery

AI Generation

Data Operations

File storage

Welcome to Moorcheh API

Base URL

Authentication

Request/Response Naming

Get Your API Key

Authentication Header

Example Request

API Endpoints

Namespace Management

Search & Discovery

AI Generation

Data Operations

Basic Workflow

Error Responses

Error Response Format

Security Best Practices

Rate Limits

SDKs and Integrations

Python SDK

LangChain

LlamaIndex

MCP Server

Chat Boilerplate

Need Help?

Quick Start

Guides

Support

GitHub

​Welcome to Moorcheh API

​Base URL

​Authentication

​Request/Response Naming

​Get Your API Key

​Authentication Header

​Example Request

​API Endpoints

Namespace Management

Search & Discovery

AI Generation

Data Operations

​Basic Workflow

​Error Responses

​Error Response Format

​Security Best Practices

​Rate Limits

​SDKs and Integrations

Python SDK

LangChain

LlamaIndex

MCP Server

Chat Boilerplate

​Need Help?

Quick Start

Guides

Support

GitHub

Welcome to Moorcheh API

Base URL

Authentication

Request/Response Naming

Get Your API Key

Authentication Header

Example Request

API Endpoints

Basic Workflow

Error Responses

Error Response Format

Security Best Practices

Rate Limits

SDKs and Integrations

Need Help?