Inkeep

Inkeep Chat Sessions API

The Chat Sessions API from Inkeep — 2 operation(s) for chat sessions.

GitHub OpenAPI

Operations 2

POST /v0/chat_sessions/chat_results Create Chat Session And Chat Result #
POST /v0/chat_sessions/{chat_session_id}/chat_results Continue Chat Session And Chat Result #

Documentation

📖
Documentation
https://docs.inkeep.com/cloud/ai-api/chat-completions-api
📖
APIReference
https://docs.inkeep.com/cloud/ai-api/rag-mode
📖
Documentation
https://docs.inkeep.com/cloud/overview/developer-platform

Specifications

⚙
OpenAPI
https://artifacts.apis.io/inkeep/openapi/inkeep-chat-sessions-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/inkeep/asyncapi/inkeep-asyncapi.yml

Other Resources

🔗
PostmanCollection
https://artifacts.apis.io/inkeep/collections/inkeep.postman_collection.json
🔗
OpenCollection
https://artifacts.apis.io/inkeep/collections/inkeep.opencollection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/inkeep:inkeep-chat-sessions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

inkeep-chat-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Inkeep Chat Sessions API
  summary: Inkeep Search and Chat API
  description: Inkeep is an AI-powered search and chat platform
  version: 0.1.0
servers:
- url: https://api.inkeep.com
  description: Production server
tags:
- name: Chat Sessions
paths:
  /v0/chat_sessions/chat_results:
    post:
      summary: Create Chat Session And Chat Result
      operationId: createChatSessionAndChatResult
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatSessionAndChatResultInput'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResult'
                anyOf:
                - $ref: '#/components/schemas/ChatResult'
                - $ref: '#/components/schemas/ChatResultStreamResponse'
                title: Response Createchatsessionandchatresult
            text/event-stream:
              schema:
                $ref: '#/components/schemas/ChatResultStreamResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Chat Sessions
  /v0/chat_sessions/{chat_session_id}/chat_results:
    post:
      summary: Continue Chat Session And Chat Result
      operationId: continueChatSessionAndChatResult
      parameters:
      - name: chat_session_id
        in: path
        required: true
        schema:
          type: string
          title: Chat Session Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContinueChatSessionAndChatResultInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                anyOf:
                - $ref: '#/components/schemas/ChatResult'
                - $ref: '#/components/schemas/ChatResultStreamResponse'
                title: Response Continuechatsessionandchatresult
                $ref: '#/components/schemas/ChatResult'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/ChatResultStreamResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Chat Sessions
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    MessageChunk:
      properties:
        chat_session_id:
          type: string
          title: Chat Session Id
        content_chunk:
          type: string
          title: Content Chunk
        finish_reason:
          anyOf:
          - type: string
            enum:
            - stop
            - length
            - content_filter
          - type: 'null'
          title: Finish Reason
      type: object
      required:
      - chat_session_id
      - content_chunk
      - finish_reason
      title: MessageChunk
    ChatResult:
      properties:
        chat_session_id:
          type: string
          title: Chat Session Id
        message:
          $ref: '#/components/schemas/Message-Output'
      type: object
      required:
      - chat_session_id
      - message
      title: ChatResult
    RecordType:
      type: string
      enum:
      - documentation
      - site
      - discourse_post
      - github_issue
      - github_discussion
      - stackoverflow_question
      - discord_forum_post
      - discord_message
      - custom_question_answer
      title: RecordType
    ChatResultStreamResponse:
      properties:
        event:
          type: string
          enum:
          - message_chunk
          - records_cited
          title: Event
        data:
          anyOf:
          - $ref: '#/components/schemas/MessageChunk'
          - $ref: '#/components/schemas/RecordCited'
          title: Data
      type: object
      required:
      - event
      - data
      title: ChatResultStreamResponse
    Record:
      properties:
        type:
          $ref: '#/components/schemas/RecordType'
        url:
          anyOf:
          - type: string
          - type: 'null'
          title: Url
        title:
          type: string
          title: Title
        breadcrumbs:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Breadcrumbs
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
      type: object
      required:
      - type
      - url
      - title
      - breadcrumbs
      - description
      title: Record
    Message-Output:
      properties:
        role:
          type: string
          const: assistant
          title: Role
        content:
          type: string
          title: Content
        records_cited:
          $ref: '#/components/schemas/RecordCited'
      type: object
      required:
      - role
      - content
      - records_cited
      title: Message
    ChatSessionInput:
      properties:
        messages:
          items:
            $ref: '#/components/schemas/ChatMessageInput'
          type: array
          title: Messages
        context:
          anyOf:
          - type: string
          - type: 'null'
          title: Context
        guidance:
          anyOf:
          - type: string
          - type: 'null'
          title: Guidance
        environment:
          anyOf:
          - type: string
          - type: 'null'
          title: Environment
        tags:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Tags
      type: object
      required:
      - messages
      title: ChatSessionInput
    CreateChatSessionAndChatResultInput:
      properties:
        integration_id:
          type: string
          title: Integration Id
        chat_session:
          $ref: '#/components/schemas/ChatSessionInput'
        chat_mode:
          type: string
          title: Chat Mode
          default: auto
        stream:
          type: boolean
          title: Stream
          default: false
      type: object
      required:
      - integration_id
      - chat_session
      title: CreateChatSessionAndChatResultInput
    RecordCited:
      properties:
        citations:
          items:
            $ref: '#/components/schemas/Citation'
          type: array
          title: Citations
      type: object
      required:
      - citations
      title: RecordCited
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Citation:
      properties:
        number:
          anyOf:
          - type: integer
          - type: 'null'
          title: Number
        record:
          anyOf:
          - $ref: '#/components/schemas/Record'
          - type: 'null'
        hit_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Hit Url
      type: object
      required:
      - number
      - record
      - hit_url
      title: Citation
    ContinueChatSessionAndChatResultInput:
      properties:
        integration_id:
          type: string
          title: Integration Id
        message:
          $ref: '#/components/schemas/ChatMessageInput'
        stream:
          type: boolean
          title: Stream
          default: false
      type: object
      required:
      - integration_id
      - message
      title: ContinueChatSessionAndChatResultInput
    ChatMessageInput:
      properties:
        role:
          type: string
          const: user
          title: Role
        content:
          type: string
          title: Content
      type: object
      required:
      - role
      - content
      title: ChatMessageInput