Skip to main content
POST
/
v1
/
knowledgebase
/
chat
/
completions
Chat with knowledge bases
curl --request POST \
  --url http://co-mind-platform-host/v1/knowledgebase/chat/completions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "gpt-4o-mini",
  "messages": [
    {
      "content": "<string>",
      "name": "<string>"
    }
  ],
  "knowledgebase_ids": [
    "kb_abc123",
    "kb_def456"
  ],
  "temperature": 1,
  "max_tokens": 2,
  "top_p": 1,
  "stream": false
}
'
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 123,
  "model": "<string>",
  "choices": [
    {
      "index": 123,
      "message": {
        "content": "<string>",
        "name": "<string>"
      }
    }
  ],
  "usage": {
    "prompt_tokens": 123,
    "completion_tokens": 123,
    "total_tokens": 123
  },
  "knowledge_base_context": {
    "sources": [
      {
        "knowledgebase_id": "<string>",
        "document_id": "<string>",
        "title": "<string>",
        "content": "<string>",
        "page": 123,
        "relevance_score": 123
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Supports two token types:

  • JWT Access Token — obtained via POST /v1/auth/login
  • Personal Access Token (PAT) — created via POST /v1/api-tokens, format: cmnd_<tokenId>.<secret>

Body

application/json
​
model
string
required
Example:

"gpt-4o-mini"

​
messages
object[]
required
​
knowledgebase_ids
string[]
required

Knowledge base IDs to use for context

Example:
["kb_abc123", "kb_def456"]
​
temperature
number
default:1
Required range: 0 <= x <= 2
​
max_tokens
integer
Required range: x >= 1
​
top_p
number
default:1
Required range: 0 <= x <= 1
​
stream
boolean
default:false

Response

Successful response

​
id
string
Example:

"chatcmpl-abc123"

​
object
string
Example:

"chat.completion"

​
created
integer
​
model
string
​
choices
object[]
​
usage
object
​
knowledge_base_context
object