kapa.ai

kapa.ai is an AI assistant and answer platform that turns technical documentation, GitHub content, forums, and developer products into a retrieval-augmented chat experience. The kapa.ai Query API lets teams ask questions, run threaded conversations with streaming answers, perform semantic retrieval and search, and pull analytics over projects and threads via a REST interface authenticated with an X-API-KEY header.

5 APIs 0 Features

AIAnswer EngineRAGDocumentationDeveloper Tools

APIs

kapa.ai Query Chat API

Ask a project's kapa.ai instance a question and receive a retrieval-augmented answer with relevant sources. Each chat call creates a new Thread; both standard and Server-Sent-Ev...

kapa.ai Threads Conversations API

List and retrieve Thread objects and continue a multi-turn conversation by chatting in an existing thread, with standard and streamed follow-up variants and a feedback endpoint ...

kapa.ai Search and Retrieval API

Semantic retrieval that returns the most relevant chunks from a project's ingested knowledge sources without LLM generation, intended to supply context to external LLMs and agen...

kapa.ai Projects API

Retrieve a project and enumerate the integrations and ingested sources configured for it, scoping every other Query API call to a project_id.

kapa.ai Analytics API

Read usage and quality analytics for a project - activity, question/answers, end users, coverage-gap periods, and top-question periods - to understand how the AI assistant is pe...

Collections

kapa.ai Query API

OPEN

Pricing Plans

Kapa Ai Plans Pricing

3 plans

PLANS

Rate Limits

Kapa Ai Rate Limits

3 limits

RATE LIMITS

FinOps

Kapa Ai Finops

FINOPS

Resources

👥

GitHubOrganization

Sources

opencollection: 1.0.0
info:
  name: kapa.ai Query API
  version: '1.0'
request:
  auth:
    type: apikey
    apikey:
      key: X-API-KEY
      value: '{{apiKey}}'
      in: header
items:
- info:
    name: Chat
    type: folder
  items:
  - info:
      name: Chat
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/projects/{project_id}/chat
      body:
        type: json
        data: "{\n  \"query\": \"How do I get started?\",\n  \"integration_id\": \"<INTEGRATION_ID>\"\n}"
    docs: Ask the project's kapa.ai instance a question. Creates a new Thread and returns the answer with relevant sources.
  - info:
      name: Chat streamed
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/projects/{project_id}/chat/stream
      body:
        type: json
        data: "{\n  \"query\": \"How do I get started?\",\n  \"integration_id\": \"<INTEGRATION_ID>\"\n}"
    docs: Streamed chat. Answer chunks are delimited by the Unicode record separator character (U+241E).
  - info:
      name: Custom chat
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/projects/{project_id}/chat/custom
      body:
        type: json
        data: "{\n  \"query\": \"How do I get started?\",\n  \"integration_id\": \"<INTEGRATION_ID>\",\n  \"context\": \"\
          Additional grounding context.\"\n}"
    docs: Chat using caller-supplied context.
- info:
    name: Threads
    type: folder
  items:
  - info:
      name: Chat in thread
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/threads/{thread_id}/chat
      body:
        type: json
        data: "{\n  \"query\": \"Can you elaborate?\",\n  \"integration_id\": \"<INTEGRATION_ID>\"\n}"
    docs: Ask a follow-up question within an existing Thread.
  - info:
      name: Chat in thread streamed
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/threads/{thread_id}/chat/stream
      body:
        type: json
        data: "{\n  \"query\": \"Can you elaborate?\",\n  \"integration_id\": \"<INTEGRATION_ID>\"\n}"
    docs: Streamed follow-up question within an existing Thread.
  - info:
      name: Retrieve a thread
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/threads/{thread_id}
    docs: Retrieve a single Thread object and its messages.
  - info:
      name: List threads
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/threads
    docs: List Thread objects for a project.
  - info:
      name: Upsert feedback
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/feedback
      body:
        type: json
        data: "{\n  \"question_answer_id\": \"<QUESTION_ANSWER_ID>\",\n  \"reaction\": \"upvote\",\n  \"comment\": \"Helpful\
          \ answer.\"\n}"
    docs: Submit or update feedback on a question/answer using its question_answer_id.
- info:
    name: Retrieval
    type: folder
  items:
  - info:
      name: Retrieval
      type: http
    http:
      method: POST
      url: https://api.kapa.ai/query/v1/projects/{project_id}/retrieval
      body:
        type: json
        data: "{\n  \"query\": \"How do I configure authentication?\",\n  \"num_results\": 5\n}"
    docs: Semantic retrieval against ingested knowledge sources without LLM generation.
  - info:
      name: Search (deprecated)
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/search?query=getting started
    docs: Deprecated keyword search across knowledge sources. Use Retrieval instead.
- info:
    name: Projects
    type: folder
  items:
  - info:
      name: Retrieve a project
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/org/v1/projects/{project_id}
    docs: Retrieve a single project by id.
  - info:
      name: List all integrations
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/integrations
    docs: List the integrations configured for a project.
  - info:
      name: List all sources
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/ingestion/v1/projects/{project_id}/sources
    docs: List the ingested knowledge sources for a project.
- info:
    name: Analytics
    type: folder
  items:
  - info:
      name: Activity data
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/activity
    docs: Retrieve activity/usage analytics for a project.
  - info:
      name: List question answers
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/question-answers
    docs: List question/answer records for a project.
  - info:
      name: List end users
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/end-users
    docs: List end users that have interacted with the project.
  - info:
      name: List coverage gaps periods
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/coverage-gaps/periods
    docs: List coverage-gap analysis periods for a project.
  - info:
      name: Retrieve coverage gaps period
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/coverage-gaps/periods/{period_id}
    docs: Retrieve a single coverage-gap period by id.
  - info:
      name: List top questions periods
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/projects/{project_id}/top-questions/periods
    docs: List top-question analysis periods for a project.
  - info:
      name: Retrieve top questions period
      type: http
    http:
      method: GET
      url: https://api.kapa.ai/query/v1/top-questions/periods/{period_id}
    docs: Retrieve a single top-question period by id.
bundled: true