Skip to main content
POST

Authorizations

Authorization
string
header
required

User session JWT or instance API key (iak_*). Send as Authorization: Bearer <token>.

Path Parameters

knowledgeBaseId
string
required

Knowledge base id. Legacy physical prefix vs_ (the kb_ rename is deferred).

Maximum string length: 128
Pattern: ^vs_[A-Za-z0-9-]+$

Body

application/json

A single JSON-RPC 2.0 request (initialize, tools/list, or tools/call).

jsonrpc
enum<string>
required
Available options:
2.0
method
enum<string>
required
Available options:
initialize,
notifications/initialized,
tools/list,
tools/call
id

Request id echoed back in the response. Omit for notifications.

params
object

For tools/call: { name, arguments } where name is one of the nine tools and arguments carries that tool's parameters. The knowledge_base_id is injected from the path and must not be sent.

Response

JSON-RPC 2.0 response envelope. Tool results follow the MCP CallToolResult shape (content[], structuredContent, isError).

jsonrpc
enum<string>
Available options:
2.0
id
result
object

Present on success (tool result, tools/list, or initialize).

error
object

Present on JSON-RPC errors (unknown method or tool, auth, rate limit).