用嘉衡來開發。

這是已實作的 REST 合約,並非公開 API 存取的要約。請使用你的部署所提供的 API 網址;公開網域及金鑰尚未開放。

發出第一個請求。

已實作的 REST 服務使用 JSON。請將 KALKAS_API_ORIGIN 設為你的服務部署網址。

這個請求會取得嘉衡涵蓋的題目,並標明你是否已持有。

curl $KALKAS_API_ORIGIN/v1/topics

API 存取

金鑰尚未開放。已實作的服務以免費讀者身分回應;不發出金鑰或啟用付費方案。

指定版本。

在 Kalkas-Version 帶上日期,每次都會得到該版本的格式;不帶,就是最新版本。

我們不支援的日期會得到 400。破壞性改動會以新日期發布,你據以開發的版本不會在你背後改變。

Kalkas-Version: 2026-10-03

放心重試。

讀取請求可以隨時重複。會更改資料的請求,請帶上長度 1 至 255 個可見字元的 Idempotency-Key。

24 小時內用同一個金鑰重複同一個請求,會得到第一次的回應;把金鑰用在另一個請求上,會得到 409,idempotency_key_reused。

Idempotency-Key: 0192f1c4-7a3e-7b21-9c55-3f0d2e8a1b4c

用游標分頁。

清單接受 limit,範圍 1 至 100,預設 20,並回應 has_more 和 next_cursor。把 next_cursor 當作 starting_after 傳回去。

游標是不透明的:只管原樣傳回,不要自己構造。事件日誌則用 after 傳遞游標。

curl -G $KALKAS_API_ORIGIN/v1/decisions \
  -d limit=50 -d starting_after=$CURSOR

錯誤,處處同一個樣子。

每個錯誤都有 type、code、message、出錯的 param 和 request_id。如要聯絡我們,請附上 request_id,它也會以 Request-Id 標頭送出。

  • 400 404 409

    invalid_request_error:請修正請求。

  • 401

    authentication_error:沒有金鑰或金鑰錯誤。

  • 403

    permission_error:你未持有該題目。

  • 429

    rate_limit_error:等候 Retry-After 指定的秒數。

  • 500 503

    api_error:等候 Retry-After 指定的秒數後再試。

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_version",
    "message": "...",
    "param": "Kalkas-Version",
    "request_id": "..."
  }
}

SSE 狀態

SSE 仍在規劃,尚未開放。目前沒有串流或 Last-Event-ID 續傳合約。請以不透明的 after 游標讀取 /v1/events。

MCP 狀態

MCP 仍在規劃,尚未開放。不提供 MCP 端點、工具、資源或訂閱協定。

Webhook

簽署 Webhook 仍在規劃,尚未開放。不提供端點登記、簽署金鑰或寄送服務。

想看每條路由和欄位?