Search & Analytics API Key

Typesense REST API

Fast, typo-tolerant search engine built for developers

Typesense is an open-source, typo-tolerant search engine optimized for instant search experiences. It provides lightning-fast search results with features like faceting, filtering, geo-search, and vector search. Developers use Typesense for building autocomplete, instant search, and semantic search experiences in applications, with a focus on speed and ease of use.

Base URL https://xyz.a1.typesense.net

API Endpoints

Method	Endpoint	Description
POST	`/collections`	Create a new collection with a defined schema for indexing documents
GET	`/collections`	List all collections in the Typesense cluster
GET	`/collections/:collection`	Retrieve metadata and schema information for a specific collection
DELETE	`/collections/:collection`	Delete a collection and all its documents permanently
POST	`/collections/:collection/documents`	Index a single document into a collection
POST	`/collections/:collection/documents/import`	Bulk import multiple documents in JSONL format
GET	`/collections/:collection/documents/search`	Search for documents with typo-tolerance, filtering, and faceting
GET	`/collections/:collection/documents/:id`	Retrieve a specific document by its ID
PATCH	`/collections/:collection/documents/:id`	Update specific fields of an existing document
DELETE	`/collections/:collection/documents/:id`	Delete a specific document from the collection
POST	`/collections/:collection/overrides`	Create search override rules to customize search results
GET	`/collections/:collection/synonyms`	List all synonym definitions for a collection
POST	`/collections/:collection/synonyms`	Define synonyms to improve search relevance
GET	`/keys`	List all API keys with their permissions and metadata
POST	`/keys`	Generate a new API key with specific permissions and expiration

Code Examples

# Create a collection
curl 'https://xyz.a1.typesense.net/collections' \
  -X POST \
  -H 'X-TYPESENSE-API-KEY: your_admin_api_key' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "products",
    "fields": [
      {"name": "title", "type": "string"},
      {"name": "price", "type": "float"},
      {"name": "category", "type": "string", "facet": true}
    ],
    "default_sorting_field": "price"
  }'

# Search documents
curl 'https://xyz.a1.typesense.net/collections/products/documents/search?q=laptop&query_by=title&filter_by=price:<1000&facet_by=category' \
  -H 'X-TYPESENSE-API-KEY: your_search_api_key'

// Using Typesense JavaScript client
import Typesense from 'typesense';

const client = new Typesense.Client({
  nodes: [{
    host: 'xyz.a1.typesense.net',
    port: '443',
    protocol: 'https'
  }],
  apiKey: 'your_search_api_key',
  connectionTimeoutSeconds: 2
});

// Search for documents
const searchParameters = {
  q: 'laptop',
  query_by: 'title,description',
  filter_by: 'price:<1000 && category:electronics',
  facet_by: 'category,brand',
  sort_by: 'price:asc',
  per_page: 20
};

const results = await client
  .collections('products')
  .documents()
  .search(searchParameters);

console.log(results.hits);

import typesense

# Initialize client
client = typesense.Client({
  'nodes': [{
    'host': 'xyz.a1.typesense.net',
    'port': '443',
    'protocol': 'https'
  }],
  'api_key': 'your_search_api_key',
  'connection_timeout_seconds': 2
})

# Create a collection
schema = {
  'name': 'products',
  'fields': [
    {'name': 'title', 'type': 'string'},
    {'name': 'price', 'type': 'float'},
    {'name': 'category', 'type': 'string', 'facet': True}
  ],
  'default_sorting_field': 'price'
}

client.collections.create(schema)

# Search documents
search_params = {
  'q': 'laptop',
  'query_by': 'title,description',
  'filter_by': 'price:<1000',
  'facet_by': 'category',
  'sort_by': 'price:asc'
}

results = client.collections['products'].documents.search(search_params)
print(results['hits'])

Use Typesense from Claude / Cursor / ChatGPT

Get a hosted MCP endpoint for Typesense. Paste your Typesense API key, copy back one URL, drop it into Claude Desktop, Cursor, or any AI client that supports remote MCP. Your AI calls Typesense directly with your credentials — no local install, works on mobile.

search_documents Search across collections with typo-tolerance, filtering, and faceting to find relevant documents

index_document Add or update documents in a collection for instant searchability

manage_collections Create, update, or delete search collections with custom schemas

configure_synonyms Define and manage synonyms to improve search relevance and user experience

create_search_overrides Set up curation rules to promote or exclude specific documents in search results

Connect in 60 seconds

Paste your Typesense key → get an MCP URL → paste into Claude/Cursor. Hosted by IOX, encrypted at rest.

Connect Typesense to your AI →

Typesense REST API

API Endpoints

Sponsor this page

Code Examples

Use Typesense from Claude / Cursor / ChatGPT

Connect in 60 seconds

Related APIs