這是一個實驗性 API。請求與回應的結構、速率限制以及權杖語意可能會變更。重大變更會透過新的日期版本 beta 標頭發布,而前兩個標頭版本會持續運作,讓呼叫端有時間進行遷移。
Claude Code 是 Anthropic 的代理式程式設計工具。Claude Code on the web 在 claude.ai/code 上由 Anthropic 管理的雲端基礎架構中執行 Claude Code 工作階段,而「routine」(例行程序)是儲存在該處的設定:包含一個提示、一或多個儲存庫以及連接器,經過封裝後可在無人值守的情況下依排程執行、回應 GitHub 事件,或透過 HTTP 呼叫時執行。
此端點即為 HTTP 進入點。對其發送 POST 請求會啟動現有例行程序的新執行,並傳回產生的工作階段 ID 與 URL。典型的呼叫端包括警示系統、CI 管線,以及需要以程式化方式啟動 Claude Code 工作階段的內部工具。
呼叫此端點需要擁有 Pro、Max、Team 或 Enterprise 方案的 claude.ai 帳戶,且已啟用 Claude Code on the web。請使用在 Claude Code 網頁 UI 中建立的個別例行程序 bearer 權杖進行驗證,而非 Claude API 金鑰。
例行程序觸發端點屬於 Claude Code 產品介面,在幾個方面與 Claude Platform 的 API 和 SDK 有所不同:
| 面向 | 此端點 | Claude Platform API |
|---|---|---|
| 驗證 | Authorization: Bearer 搭配在 claude.ai/code/routines 建立的個別例行程序權杖(sk-ant-oat01-...) | x-api-key 搭配來自 Claude Console 的 Claude API 金鑰 |
| 權杖範圍 | 僅限單一例行程序;無讀取存取權 | 工作區層級 |
| SDK 支援 | 無 | 所有用戶端 SDK 皆可使用 |
| 計費 | claude.ai 上的 Claude Code 訂閱用量 | Claude Platform 用量 |
| 路徑命名空間 | /v1/claude_code/... | /v1/... |
| 穩定性 | 實驗性;需要 anthropic-beta: experimental-cc-routine-2026-04-01 | 穩定版或標準 beta |
若要呼叫此端點,您需要:
如需完整的設定逐步說明,請參閱 Claude Code 文件中的新增 API 觸發器。
POST https://api.anthropic.com/v1/claude_code/routines/{routine_id}/fire每個請求都必須包含 anthropic-beta: experimental-cc-routine-2026-04-01 標頭。未包含此標頭的請求會傳回 400 invalid_request_error。
當您新增 API 觸發器時,Claude Code 網頁 UI 會在權杖旁提供完整的 URL,因此大多數整合會將兩者都儲存為密鑰並直接呼叫端點。以下範例展示一個 shell 呼叫,以及一個在 CI 失敗時觸發例行程序的 GitHub Actions 步驟。
curl -X POST https://api.anthropic.com/v1/claude_code/routines/$ROUTINE_ID/fire \
-H "Authorization: Bearer $ROUTINE_TOKEN" \
-H "anthropic-version: 2023-06-01" \
-H "anthropic-beta: experimental-cc-routine-2026-04-01" \
-H "Content-Type: application/json" \
-d '{"text": "Sentry alert SEN-4521 fired in prod. Stack trace attached."}'- if: failure()
env:
ROUTINE_FIRE_URL: ${{ secrets.ROUTINE_FIRE_URL }}
ROUTINE_FIRE_TOKEN: ${{ secrets.ROUTINE_FIRE_TOKEN }}
run: |
curl -X POST "$ROUTINE_FIRE_URL" \
-H "Authorization: Bearer $ROUTINE_FIRE_TOKEN" \
-H "anthropic-version: 2023-06-01" \
-H "anthropic-beta: experimental-cc-routine-2026-04-01" \
-H "Content-Type: application/json" \
-d "{\"text\": \"CI failed: $GITHUB_WORKFLOW run $GITHUB_RUN_ID on $GITHUB_REF\"}"請求會在工作階段建立後傳回。它不會串流工作階段輸出,也不會等待工作階段完成。
| 名稱 | 必要 | 說明 |
|---|---|---|
Authorization | 是 | Bearer <token>。在 Claude Code 網頁 UI 中建立的個別例行程序權杖,前綴為 sk-ant-oat01-。 |
anthropic-beta | 是 | 必須包含 experimental-cc-routine-2026-04-01。 |
anthropic-version | 是 | API 版本,例如 2023-06-01。 |
Content-Type | 當有請求主體時 | application/json。 |
| 名稱 | 類型 | 說明 |
|---|---|---|
routine_id | string | 例行程序的識別碼。儘管參數名稱如此,其值的前綴為 trig_ 而非 routine_。包含在您新增 API 觸發器時對話框所顯示的 URL 中。 |
| 欄位 | 類型 | 必要 | 說明 |
|---|---|---|---|
text | string | 否 | 此次執行的初始上下文,例如警示內容、失敗的日誌行或 git diff。此值為自由格式文字且不會被解析;如果您傳送 JSON 或其他結構化酬載,例行程序會將其視為字面字串接收。會與例行程序已儲存的提示一併傳遞給例行程序。最多 65,536 個字元。 |
請求主體為選用。主體中的未知欄位會被忽略。
成功的請求會傳回 200 OK 以及新工作階段的詳細資訊:
{
"type": "routine_fire",
"claude_code_session_id": "session_01HJKLMNOPQRSTUVWXYZ",
"claude_code_session_url": "https://claude.ai/code/session_01HJKLMNOPQRSTUVWXYZ"
}| 欄位 | 類型 | 說明 |
|---|---|---|
type | string | 一律為 routine_fire。 |
claude_code_session_id | string | 為此次執行建立的 Claude Code 工作階段 ID。 |
claude_code_session_url | string | 連至 claude.ai 上該工作階段的連結。在瀏覽器中開啟即可觀看執行過程、檢閱變更或繼續對話。 |
錯誤使用標準的 Anthropic 錯誤封裝格式:
{
"type": "error",
"error": {
"type": "not_found_error",
"message": "<string>"
}
}| HTTP 狀態 | 錯誤類型 | 原因 |
|---|---|---|
| 400 | invalid_request_error | 缺少或無效的 anthropic-beta 標頭、text 超過 65,536 個字元,或例行程序已暫停。 |
| 401 | authentication_error | Authorization 標頭中沒有 bearer 權杖,或權杖與此例行程序不符。 |
| 403 | permission_error | 該帳戶或組織沒有此端點的存取權。 |
| 404 | not_found_error | 例行程序不存在。 |
| 429 | rate_limit_error | 已達到帳戶的例行程序執行限制或用量限制。回應包含 Retry-After 標頭,指出時間窗口何時重設。 |
| 500 | api_error | 非預期的伺服器錯誤。 |
| 503 | overloaded_error | 服務暫時過載。請在短暫延遲後重試。Claude Platform 針對此錯誤類型傳回 529;此端點則傳回 503。 |
Bearer 權杖的範圍僅限於單一例行程序。遭洩露的權杖只能觸發該例行程序;它不授予讀取存取權、不授予其他例行程序的存取權,也不授予帳戶資料的存取權。
請從 claude.ai/code/routines 的例行程序 API 觸發器設定中產生和撤銷權杖。目前沒有用於權杖管理的公開 API。產生新權杖會撤銷先前的權杖。
每個成功的請求都會建立一個新的工作階段。沒有冪等性金鑰。如果 webhook 呼叫端重試,端點會建立多個工作階段。
例行程序執行會計入每個帳戶的每日配額,該配額依方案而異,且產生的工作階段會消耗與互動式工作階段相同的 Claude Code 訂閱用量。當達到任一限制時,端點會傳回 429 rate_limit_error 並附帶 Retry-After 標頭。已啟用額外用量的組織在超過內含配額後,會以計量超額方式繼續使用。
您剩餘的每日執行次數會顯示在 claude.ai/code/routines。如需了解例行程序用量如何與訂閱限制及額外用量計費互動,請參閱 Claude Code 文件中的用量與限制。
此端點未包含在 Anthropic SDK 中。其權杖模型與 API 金鑰驗證不同,且典型的呼叫端(例如 CI 作業和警示 webhook)會直接傳送請求。
Was this page helpful?