Ankk CLI/API 開發者指南

快速入門

依序測試 CLI 安裝、API 金鑰設定，以及向金鑰所屬品牌發佈內容。

安裝或運作一次

公開套件名稱為 @anakonn/ankk，指令名稱為 ankk。執行 CLI 需要 Bun。

bunx @anakonn/ankk --json health
bun install -g @anakonn/ankk
ankk --json health

安全配置

使用 Ankk 發行的 API 金鑰。指令輸出會遮蔽完整金鑰；CI 可透過環境變數設定。

ankk config setup --scope global
ANKK_API_KEY=spk_... ankk config setup --scope project --api-key-env ANKK_API_KEY --yes
ankk config show

發佈準備好的內容

將內容儲存為 JSON 檔案，再送至與 API 用戶端相同的公開排程介面。

ankk brand get --json
ankk contents publish --file payload.json
ankk contents publish --file payload.json --scheduled-for 2026-07-01T09:00:00Z

寄 JSON 而非重建表單

有效負載

以 --file 傳入內容。腳本或 AI 工具可產生 JSON 檔案，不必組合大量命令列選項。

{
	"connection_id": "<connection_id>",
	"idempotency_key": "launch-thread-2026-07-01",
	"sns_type": "threads",
	"text": "Launch update from Ankk",
	"scheduled_for": "2026-07-01T09:00:00Z"
}

含有客戶資料的範例檔案請勿儲存至 Git。
使用冪等鍵安全地重複執行自動化。
已接收表示請求已通過驗證、儲存並排程。請查看最終狀態以確認發佈成功。

直接呼叫公開 API

API

CLI 操作對應公開 /v1 API。使用 Bearer 驗證；API 金鑰會決定 /v1/brand 路徑所操作的品牌。

curl -X POST https://api.ankk.app/v1/brand/contents \
  -H "Authorization: Bearer spk_..." \
  -H "Content-Type: application/json" \
  --data @payload.json

使用 GET /v1/brand 查看金鑰所屬品牌。
請至 /v1/docs 與 /v1/openapi.json 查看公開介面規格。
切勿將完整 API 金鑰貼至日誌或支援單。

追蹤請求接收後的狀態

狀態

已接收表示請求已通過驗證、儲存並排程。請查看最終狀態以確認發佈成功。

ankk contents list --json
ankk contents get --content-id <content_id> --json

狀態代碼: accepted, queued, publishing, published, failed, retry.
使用具簽章的 Webhook 將狀態更新傳送至其他系統。
接收請求是第一步。追蹤每則貼文的處理過程與最終發佈結果，並在需要時檢查失敗原因。

提示AI工具使用Ankk，而不是取代它

自行撰寫內容或使用外部 AI 工具準備草稿，在支援的頻道預約貼文，並在 Ankk 追蹤發佈結果。

Codex

根據這份版本說明建立 Threads 發佈資料，儲存為 tmp/launch-thread.json，再用已設定的品牌執行 ankk contents publish。

Claude Code

檢查 payload.json 是否包含 connection_id、idempotency_key、sns_type、text 與 scheduled_for，然後顯示正確的 ankk contents publish 指令。

ChatGPT

撰寫三個適合各頻道的文案版本，並回傳可供 ankk contents publish --file payload.json 使用的 JSON 檔案。

安全邊界

請勿對模型、日誌、螢幕截圖或問題評論公開完整的 spk_ API 金鑰。
不要告訴使用者命令成功意味著提供者發布已經成功。
請勿將隱藏或休眠的 CLI 指令記錄為公共功能。
使用API 金鑰、webhooks 和狀態檢查實現自動化，而非直接資料庫存取。

透過 CLI、API 與 AI 工具使用 Ankk