indx/docs

HTTP API Reference

For non-.NET tech stacks, deploy the Indx server and interact via REST.

Base URL

https://localhost:5001/api/

All endpoints require JWT Bearer authentication.

OpenAPI Spec

Every Indx server publishes its own spec; on a local instance:

https://localhost:5001/swagger/v2.0-beta/swagger.json

API Sections

  • Endpoints — Complete endpoint reference grouped by category
  • Search — Executing searches and retrieving results
  • Filters — Creating and combining filters via REST
  • Schemas — Request and response schema reference
  • Data Loading — Loading datasets and configuring fields

Quick Start

bash
# 1. Create a token on the Indx Dashboard (Account > API Key)

# 2. Search (send the token as a Bearer header)
curl -X POST https://localhost:5001/api/teams/acme/datasets/products/Search \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"text": "wireless headphones", "maxNumberOfRecordsToReturn": 20}'