JitKnow API 开放平台

🌐 语言版本 · Language · 言語

中文 English 日本語

企业级 AI 知识库 · 开发者接入文档

API Version SSE Stream Auth License Contact

🚀 5 分钟接入,让你的网站、App、内部系统拥有专属 AI 知识库问答能力。
嵌入式 Widget · RESTful Chat API · SSE 流式输出 · Citations 知识引用溯源

立即体验 · 查看在线文档 · 技术支持

目录

✨ 产品简介

🗺️ 能力全景

┌─────────────────────────────────────────────────────────────┐
│ JitKnow 开放平台 │
├─────────────────┬─────────────────┬─────────────────────────┤
│ 📦 嵌入式 Widget │ 📡 Chat API │ 🔐 安全与管控 │
├─────────────────┼─────────────────┼─────────────────────────┤
│ 悬浮气泡 Widget │ GET /info │ API Key 权限隔离 │
│ iframe 嵌入 │ POST /chat (SSE)│ IP 白名单访问控制 │
│ 深色/浅色主题 │ 多轮对话上下文 │ RPM 速率限流 │
│ 自定义颜色位置 │ Citations 溯源 │ 日调用配额 │
│ 1行代码接入 │ 流式实时输出 │ Key 过期时间管理 │
└─────────────────┴─────────────────┴─────────────────────────┘

⚡ 快速开始(5步)

Step 1 · 注册并创建 AI 助手

Step 2 · 获取 API Key

Step 3 · 验证接口连通性

# 获取助手信息,验证 Key 是否有效
curl https://know.jitword.com/open/v1/info \
 -H "Authorization: Bearer jk-xxxxxxxxxxxxxxxx"

Step 4 · 发起流式对话

curl -X POST https://know.jitword.com/open/v1/chat \
 -H "Authorization: Bearer jk-xxxxxxxxxxxxxxxx" \
 -H "Content-Type: application/json" \
 -d '{"message":"产品有哪些核心功能?"}' \
 --no-buffer

Step 5 · 嵌入你的产品

<script>
 window.JitMindConfig = {
 assistantId: 'your-assistant-id',
 token: 'jk-xxxxxxxxxxxxxxxx',
 baseUrl: 'https://know.jitword.com',
 btnLabel: '智能助手',
 btnColor: '#165DFF'
 }
</script>
<script src="https://know.jitword.com/know/embed.js"></script>

📦 嵌入式 Widget 接入

悬浮气泡 Widget

<script>
 window.JitMindConfig = {
 assistantId: 'your-assistant-id', // 必填:AI 助手 ID
 token: 'jk-xxxxxxxxxxxxxxxx', // 必填:API Key
 baseUrl: 'https://know.jitword.com', // 可选:私有化部署时需指定
 btnLabel: '智能助手', // 可选:悬浮按钮文案
 btnColor: '#6366F1', // 可选:按钮颜色(CSS 颜色值)
 theme: 'light', // 可选:'light' | 'dark'
 position: 'bottom-right', // 可选:悬浮按钮位置
 width: 380, // 可选:面板宽度(px)
 height: 600 // 可选:面板高度(px)
 }
</script>
<script src="https://know.jitword.com/know/embed.js"></script>

iframe 嵌入

<iframe
 src="https://know.jitword.com/know/embed/{assistantId}?key=jk-xxxxxxxxxxxxxxxx&theme=light"
 width="400"
 height="600"
 style="border:none; border-radius:16px; box-shadow:0 4px 24px rgba(0,0,0,0.12)"
 allow="clipboard-write"
></iframe>

JitMindConfig 参数说明

📡 API 参考文档

鉴权方式

Authorization: Bearer jk-xxxxxxxxxxxxxxxx

GET /info · 获取助手信息

curl https://know.jitword.com/open/v1/info \
 -H "Authorization: Bearer jk-xxxxxxxxxxxxxxxx"

{
 "id": "asst_abc123",
 "name": "产品知识库助手",
 "description": "负责解答产品相关问题",
 "knowledge_base": "产品知识库",
 "model": "gpt-4o",
 "welcomeMessage": "你好!我是产品助手,有什么可以帮你?",
 "suggested_questions": [
 "产品有哪些核心功能?",
 "如何快速上手?",
 "支持哪些文件格式?"
 ]
}

POST /chat · 发起流式对话(SSE)

Authorization: Bearer jk-xxxxxxxxxxxxxxxx
Content-Type: application/json
Accept: text/event-stream

{
 "message": "如何申请退款?",
 "conversationId": "conv_xxx"
}

event: conversation_meta
data: {"conversation_id":"conv_a1b2c3d4"}
event: block_start
data: {}
event: block_delta
data: {"delta":"根据退款政策,您可以"}
event: block_delta
data: {"delta":"在购买后 7 天内申请退款..."}
event: block_replace
data: {"blocks":[{"type":"text","content":"根据退款政策,您可以在购买后 7 天内申请退款。\n\n申请步骤:\n1. 登录账户\n2. 进入订单详情\n3. 点击「申请退款」","citations":[{"title":"退款政策","source":"用户协议.pdf","page":3,"excerpt":"消费者可在购买后7个自然日内..."}]}]}
data: [DONE]

SSE 事件说明

监听 block_delta → 实时追加文本,实现打字机效果
监听 block_replace → 用完整内容替换(处理 Markdown 格式化)
监听 [DONE] → 关闭连接,隐藏 loading
保存 conversation_id → 用于下一轮对话的 conversationId 参数

"citations": [
 {
 "title": "退款政策",
 "source": "用户协议.pdf",
 "page": 3,
 "excerpt": "消费者可在购买后7个自然日内申请退款..."
 }
]

💻 多语言代码示例

cURL

# ── 1. 获取助手信息 ──────────────────────────────────────────
curl https://know.jitword.com/open/v1/info \
 -H "Authorization: Bearer jk-xxxxxxxxxxxxxxxx"
# ── 2. 发起流式对话(新会话)────────────────────────────────
curl -X POST https://know.jitword.com/open/v1/chat \
 -H "Authorization: Bearer jk-xxxxxxxxxxxxxxxx" \
 -H "Content-Type: application/json" \
 -d '{"message":"产品有哪些核心功能?"}' \
 --no-buffer
# ── 3. 多轮对话(续接上一轮)────────────────────────────────
curl -X POST https://know.jitword.com/open/v1/chat \
 -H "Authorization: Bearer jk-xxxxxxxxxxxxxxxx" \
 -H "Content-Type: application/json" \
 -d '{"message":"能详细说说第一点吗?","conversationId":"conv_a1b2c3d4"}' \
 --no-buffer

JavaScript

// JitKnow SSE 流式对话 - JavaScript / TypeScript 示例
const API_KEY = 'jk-xxxxxxxxxxxxxxxx'
const BASE_URL = 'https://know.jitword.com/open/v1'
/**
 * 向 AI 助手发送消息,流式输出到页面
 * @param {string} message - 用户消息
 * @param {string} [conversationId] - 多轮对话 ID(可选)
 * @param {function} [onDelta] - 每收到增量文本时的回调
 * @returns {Promise<string>} 返回最终完整内容
 */
async function askAssistant(message, conversationId, onDelta) {
 const response = await fetch(`${BASE_URL}/chat`, {
 method: 'POST',
 headers: {
 'Authorization': `Bearer ${API_KEY}`,
 'Content-Type': 'application/json'
 },
 body: JSON.stringify({ message, conversationId })
 })
 if (!response.ok) {
 const err = await response.json()
 throw new Error(`API Error ${response.status}: ${err?.error?.message}`)
 }
 const reader = response.body.getReader()
 const decoder = new TextDecoder()
 let buffer = ''
 let currentEvent = ''
 let finalContent = ''
 while (true) {
 const { done, value } = await reader.read()
 if (done) break
 buffer += decoder.decode(value, { stream: true })
 const lines = buffer.split('\n')
 buffer = lines.pop() || ''
 for (const line of lines) {
 // 解析事件类型行
 if (line.startsWith('event: ')) {
 currentEvent = line.slice(7).trim()
 continue
 }
 // 空行 = 事件结束
 if (!line.trim()) { currentEvent = ''; continue }
 // 跳过非 data 行
 if (!line.startsWith('data: ')) continue
 const raw = line.slice(6).trim()
 if (!raw || raw === '[DONE]') continue
 const data = JSON.parse(raw)
 if (currentEvent === 'block_delta' && data.delta) {
 // 流式增量:追加到 UI(打字机效果)
 onDelta?.(data.delta)
 }
 if (currentEvent === 'block_replace' && data.blocks?.[0]) {
 // 最终完整内容(含 Markdown 格式化和 Citations)
 finalContent = data.blocks[0].content
 const citations = data.blocks[0].citations || []
 // 可在此处理 Citations 引用展示
 console.log('引用来源:', citations)
 }
 }
 }
 return finalContent
}
// ── 使用示例 ────────────────────────────────────────────────
const outputEl = document.getElementById('output')
askAssistant(
 '产品有哪些核心功能?',
 undefined, // 新会话,不传 conversationId
 (delta) => { // 实时追加文本
 outputEl.textContent += delta
 }
).then(finalContent => {
 // 用最终格式化内容替换流式结果
 outputEl.innerHTML = markdownToHtml(finalContent) // 使用你的 Markdown 渲染库
})

Python

# JitKnow SSE 流式对话 - Python 示例
# 依赖:pip install requests
import requests
import json
API_KEY = "jk-xxxxxxxxxxxxxxxx"
BASE_URL = "https://know.jitword.com/open/v1"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}
def get_info() -> dict:
 """获取助手信息"""
 resp = requests.get(f"{BASE_URL}/info", headers=HEADERS)
 resp.raise_for_status()
 return resp.json()
def chat_stream(message: str, conversation_id: str = None) -> str:
 """
 发起 SSE 流式对话

 :param message: 用户消息
 :param conversation_id: 多轮对话 ID(可选)
 :return: 最终完整回复内容
 """
 body = {"message": message}
 if conversation_id:
 body["conversationId"] = conversation_id
 final_content = ""
 current_event = ""
 with requests.post(
 f"{BASE_URL}/chat",
 headers={**HEADERS, "Content-Type": "application/json"},
 json=body,
 stream=True
 ) as resp:
 resp.raise_for_status()
 for line in resp.iter_lines(decode_unicode=True):
 if line.startswith("event: "):
 current_event = line[7:].strip()
 elif line.startswith("data: "):
 raw = line[6:].strip()
 if not raw or raw == "[DONE]":
 continue
 data = json.loads(raw)
 if current_event == "block_delta" and "delta" in data:
 # 实时打印增量文本(打字机效果)
 print(data["delta"], end="", flush=True)
 elif current_event == "block_replace" and "blocks" in data:
 # 获取最终完整内容
 block = data["blocks"][0]
 final_content = block.get("content", "")
 citations = block.get("citations", [])
 if citations:
 print("\n\n📚 引用来源:")
 for c in citations:
 print(f" - {c['title']} ({c['source']}, 第{c.get('page','-')}页)")
 elif not line:
 current_event = ""
 print() # 换行
 return final_content
# ── 使用示例 ────────────────────────────────────────────────
if __name__ == "__main__":
 # 获取助手信息
 info = get_info()
 print(f"助手名称:{info['name']}")
 print(f"欢迎语:{info['welcomeMessage']}\n")
 # 第一轮对话
 print("用户:产品有哪些核心功能?\nAI:", end="")
 chat_stream("产品有哪些核心功能?")
 # 多轮对话(需要保存 conversation_id,此处为示例)
 # conv_id = "conv_a1b2c3d4" # 从 conversation_meta 事件获取
 # chat_stream("能详细说说第一点吗?", conversation_id=conv_id)

🔐 安全与限流

第一层:API Key 权限隔离

创建 Key → [启用中] → 禁用 → [已禁用] → 重新启用
 ↓
 删除(不可恢复)

第二层:IP 白名单(可选)

第三层:调用频次控制

调用日志与审计

🚨 错误码参考

{
 "error": {
 "code": "rate_limit_exceeded",
 "message": "您的 API Key 已超过每分钟调用限制(20次/分钟),请稍后重试。",
 "retry_after": 30
 }
}

async function callWithRetry(fn, maxRetries = 3) {
 for (let attempt = 0; attempt < maxRetries; attempt++) {
 try {
 return await fn()
 } catch (err) {
 if (err.status === 429) {
 const retryAfter = err.retryAfter || 30
 await sleep(retryAfter * 1000)
 continue
 }
 if (err.status === 503 && attempt < maxRetries - 1) {
 await sleep(2 ** attempt * 1000) // 指数退避
 continue
 }
 throw err
 }
 }
}

❓ 常见问题 FAQ

📞 联系我们

注册账号,立即获取 API Key →

© 2026 JitKnow

用一行代码,给你的产品装上 AI 知识大脑。