定義一張表,API 就已經寫好了。
透過 API 宣告欄位、權限、規則、自動化與跨表寫入。本手冊描述下方釘選的已合併後端原始碼;套用到特定環境前,請先核對該環境部署的提交。
- 欄位型別
- 20
- 已收錄端點
- 211
- 實際掛載路由
- 508
- IaC 行類型
- 12
效能專案的契約,於 2026-11-03 至 2026-11-04(Asia/Taipei)合併進 backend master:#2816(cursor 讀取資料列與資料列筆數)、#2820(Agent 工具箱、MCP 與 workspace SDK 採用同一套 cursor 與筆數契約)、#2806(指令摘要)、#2807(純量陣列指令 input 與精簡的 select)、#2805(bulk-insert ticket 耗時)與 #2808(回應壓縮);指令清單的 `?name=` 查詢來自 #2644。來源:teamsync-backend master 3856f7710f473602367ae2580b16047a4d2ffbc1(該 commit 的 VERSION 為 5.32.1),加上疊在它之上合併的 #2820(merge commit 8da4670c7a8a0b6ce281f963b8fb515a58eba49f,VERSION 同為 5.32.1),以及更正 #2824(已合併為 7eff5613e)。這裡沒有任何內容驗證過部署狀況。本次只涵蓋這些變更:5.22.0 到這些 commit 之間的其他變更,這裡尚未記錄。新的路由與有變動的 schema,放在一份小型的 OpenAPI overlay 中,疊在仍固定於 7c41cbc5(VERSION 5.13.0)的快照之上。請先檢查:沒有帶 `page_mode` 的請求行為和以前相同,仍會回傳精確的 `total`,但它現在已列為棄用,等前端遷移完成後,會連同 `offset` 與 `skip` 一起移除;資料列的分頁與筆數讀取(包含 offset 分頁)現在都有讀取時間上限,預設 15 秒,超過就回 `400 ct.query_timeout`;另外 `POST …/records/count` 的開放範圍跟著搜尋走,不對整合 API key 開放(和每一條路由一樣,舊版 `full` scope 的 key 是例外):#2816 起初讓 `third_party` 與 `specific_chatroom` key 也能呼叫它,#2824 把它重新對這類 key 關閉。 最新來源更新
這份手冊怎麼用
快速開始照順序讀一次就好:它會讓你手上有 token、帳號裡有一張真的表。之後這個站就是隨查隨用的參考資料。
真正值得在設計 schema 之前讀完的是核心概念。欄位識別(顯示名稱與內部 col_<hex> 鍵)、三種範圍、權限模型,這三件事決定了後面每一次呼叫的行為,也是接接口時最常踩坑的地方。
操作指南是任務導向的,一頁對應一件你被交辦的事。實戰案例比較長,一個領域一篇,每篇都從零把一套表格設計做完。
API 參考和 Playground、程式碼產生器讀的是同一份端點目錄,所以同一個路由的參數、範圍、範例、錯誤,在任何地方看到都一致。變更紀錄則記錄哪裡動了、動到哪些端點。
內容從哪裡來
AI 也是一等公民:/llms.txt 是索引,/llms-full.txt 是全文,每一頁在同一路徑後面加上 .md 就是純 Markdown 版本。
目前來源 pin:手冊文字已與後端發行版 5.22.0(36270f5a2b83fdd71b6641ad94cee707f8028292,即 tag v5.22.0 的程式碼樹)同步。離線 OpenAPI 快照、端點目錄與 Playground 另外固定在較早的版本:data/openapi.source.json 記錄它們的提交(origin/master 上的 7c41cbc50170b3003ba16ee099f1db4e78f61d1a,VERSION 為 5.13.0)與產生器。這兩個 pin 都不代表已部署。後來的一組變更——backend master 3856f7710f473602367ae2580b16047a4d2ffbc1(VERSION 為 5.32.1)的效能專案契約(見更新紀錄)——是透過一份小型 overlay(data/openapi.overlay.json,出處記錄在 data/openapi.overlay.source.json)進入端點目錄與參考手冊,這份 overlay 取自 https://api.scfg.io/openapi.json 在 11 月 4 日提供的 OpenAPI 文件(只是資料出處,不代表已部署);疊在該 commit 之上合併的 #2820(8da4670c7a8a0b6ce281f963b8fb515a58eba49f)沒有新增任何 REST schema,只以文字說明,主要在 Agent 工具箱頁面;除此之外沒有查詢任何 staging 或 production 端點,也沒有對它們做過任何實測。更新紀錄中最後一個在 production 映像上驗證過的發行版是 v5.10.11(70862ceae7869470c14f4ed7cc7dfc3609e299f4);之後的變更在更新紀錄中標示為「已合併,尚未部署到測試環境」。