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 Analytics API

Log conversations, feedback, and custom interaction events.

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

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

4 operations 4 paths 7 schemas 1 GET3 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 Analytics 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 4

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

Analytics 4

Log conversations, feedback, and custom interaction events.

POST
/conversations
Log an OpenAI-compatible conversation.
createConversation body → 200401
GET
/conversations/{id}
Fetch a logged conversation.
getConversation 1 param → 200404
POST
/feedback
Log end-user feedback for a message.
createFeedback body → 200
POST
/events
Log a custom interaction event.
logEvent body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Conversation (4 properties), CreateConversationRequest (4 properties), Feedback (4 properties), Event (3 properties). Each schema is shown below with its type and property counts.

CreateEventRequest
object
3 properties 1 required
CreateFeedbackRequest
object
3 properties 2 required
ChatMessage
object
2 properties 2 required
Event
object
3 properties 2 required
Feedback
object
4 properties 2 required
CreateConversationRequest
object
4 properties 2 required
Conversation
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

inkeep-analytics-api-openapi.yml Raw ↑

Other APIs Inkeep publishes across the network.

Inkeep Agents / Management API
Inkeep Chat API