OpenIndex Retrieval Plugin API API

by openindex.ai

Overview

A retrieval API for querying and filtering documents based on natural language queries and metadata

OpenIndex Retrieval Plugin API is a machine learning API from openindex.ai. Requests are authenticated with a bearer token. It is served over HTTPS. Its OpenAPI description documents 1 endpoints.

At a glance

Authentication: Bearer token
HTTPS: Yes
CORS: Unknown
Category: Machine Learning
Base URL: https://retriever.openindex.ai
Version: 1.0.0
Endpoints: 1
OpenAPI: Specification ↗
Spec updated: 2023-04-18

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X POST "https://retriever.openindex.ai/query" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://retriever.openindex.ai/query", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "POST",
    "https://retriever.openindex.ai/query",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())