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

Inkeep Chat API

OpenAI-compatible RAG chat completions over your content.

Inkeep Chat API is one of 3 APIs that Inkeep publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Chat. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 8 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.inkeep.com/v1.

1 operations 1 paths 8 schemas 1 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.inkeep.com/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Inkeep Chat API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Inkeep API key) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Bearer token using an API key created in the Inkeep dashboard under Projects Assistants Create assistant API. Set the header Authorization: Bearer .

Paths & Operations 1

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

Chat 1

OpenAI-compatible RAG chat completions over your content.

POST
/chat/completions
Create a RAG chat completion (OpenAI-compatible).
createChatCompletion 1 param body → 200401429

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ChatCompletion (6 properties), ChatCompletionChunk (5 properties), CreateChatCompletionRequest (5 properties), AssistantMessage (3 properties). Each schema is shown below with its type and property counts.

CreateChatCompletionRequest
object
5 properties 2 required
ChatCompletionChunk
object
A single streamed chunk of an SSE chat completion response.
5 properties 5 required
Usage
object
3 properties
Citation
object
1 property
ChatMessage
object
2 properties 2 required
ChatCompletion
object
An OpenAI-compatible chat completion response.
6 properties 5 required
AssistantMessage
object
3 properties 2 required
ChatCompletionChoice
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inkeep-chat-api-openapi.yml Raw ↑

Other APIs Inkeep publishes across the network.

Inkeep Agents / Management API
Inkeep Analytics API