Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

kapa.ai Chat API

Ask questions and create threads.

kapa.ai Chat 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 Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 6 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.

3 operations 3 paths 6 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.kapa.ai/query/v1
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

kapa.ai Chat 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 3

Across 3 paths, the API surfaces 3 operations — 3 POST. Each is listed below with its method, path, parameters, and response codes.

Chat 3

Ask questions and create threads.

POST
/query/v1/projects/{project_id}/chat
Chat
chat 1 param body → 200401
POST
/query/v1/projects/{project_id}/chat/stream
Chat streamed
chatStream 1 param body → 200401
POST
/query/v1/projects/{project_id}/chat/custom
Custom chat
chatCustom 1 param body → 200401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ChatResponse (5 properties), ChatRequest (3 properties), RelevantSource (3 properties), User (2 properties). Each schema is shown below with its type and property counts.

User
object
2 properties
ChatResponse
object
5 properties
Error
object
1 property
RelevantSource
object
3 properties
ChatRequest
object
3 properties 1 required
CustomChatRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kapa-ai-chat-api-openapi.yml Raw ↑

Other APIs kapa.ai publishes across the network.

kapa.ai Analytics API
kapa.ai Feedback API
kapa.ai Projects API
kapa.ai Retrieval API
kapa.ai Threads API