API 參考

Chat API

以程式驅動對話,可同步或串流,每則回覆都附上檢索來源。

一次對話輪次怎麼被處理

每一則訊息,不管來自小工具、API 或即時通訊管道,走的都是同一條流水線。先過驗證與成員資格/額度檢查,接著由檢索為答案建立依據,然後跑工具迴圈,最後把這一輪以欄位加密的方式寫入儲存,記憶寫入與跨管道派送則在背景進行。

同步對話

curl https://chat.agent4.io/chat \
  -H "X-API-Key: tk_live_…" \
  -H "X-End-User: lead-1024" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "I need a bridge loan for 3 months",
    "session_id": null,
    "agent": null
  }'

請求欄位

欄位型別說明
messagestring使用者的訊息。
session_idstring | null省略即開啟新的工作階段;帶入回傳的 id 則接續原對話。
agentstring | null代理名稱;省略時使用租戶預設代理。
knumber | null覆寫這次要檢索幾個知識片段。
imagesstring[] | null本輪要送出的 Data-URL(base64)圖片,用於多模態。
audiostring | nullData-URL 音訊;由伺服器端轉成文字後當作訊息使用。

回應

{
  "session_id": "6f1e…",
  "reply": "For a 3-month bridge loan our current terms are…",
  "sources": [
    { "document_id": "a3b4…", "distance": 0.18 }
  ],
  "transcript": null
}

sources 列出這個答案所依據的知識庫文件,可以用來渲染出處標註。有送 audio 時才會有 transcript

串流

POST /chat/stream 接受相同的請求內容,並以 server-sent events 回傳,讓你邊收邊渲染 token:

curl -N https://chat.agent4.io/chat/stream \
  -H "X-API-Key: tk_live_…" \
  -H "X-End-User: lead-1024" \
  -H "Content-Type: application/json" \
  -d '{ "message": "Compare your 3 and 6 month terms" }'

語言

回覆語言會跟著對話走。送出 Accept-Language 標頭可以指定系統訊息與跟進郵件的語言;平台的七種語言為 enzhzh-TWesru

完整的端點清單,包含工作階段、文件、空間與用量,會依即時的 OpenAPI schema 呈現在主控台的 API docs 頁面。