kapa.ai Retrieval API
Semantic retrieval and keyword search.
kapa.ai Retrieval API is one of 6 APIs that kapa.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Retrieval. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://api.kapa.ai.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
kapa.ai Retrieval API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-KEY (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— kapa.ai project API key, created in the API Keys tab of the platform.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Semantic retrieval and keyword search.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are RetrievedChunk (4 properties), RetrievalRequest (2 properties), RetrievalResponse (1 property), Error (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from kapa.ai 5
Other APIs kapa.ai publishes across the network.