API 文件

DeepManim 公開 API v1

開始使用

DeepManim API 讓你可以透過程式產生教育動畫影片。從文字提示詞建立影片,逐步改善並新增旁白——全部透過簡單的 REST API 完成。

基礎 URL: https://api.deepmanim.com/api/v1

重要說明

  • 產生時的音訊: 透過 /generate 產生新影片時,預設會包含音訊旁白。
  • 修改時沒有音訊: 透過 /improve 改善影片時,結果不包含音訊。請先完成所有修改,滿意後再透過 /audio 新增音訊。
  • 預估時間: 影片產生大約需要 6 分鐘。任務回應中的 estimated_time_remaining_seconds 欄位會顯示即時倒數。

身分驗證

所有 API 請求都需要 API 金鑰。請在應用程式的「設定 → API 金鑰」中建立金鑰。

需要購買點數。 曾經購買過點數的使用者可以使用 API。只有免費方案點數還不夠。

將金鑰放入 Authorization 請求標頭:

Authorization: Bearer dm_k_your_api_key_here

請保密你的 API 金鑰。 不要在公開程式碼儲存庫或用戶端應用程式中分享金鑰。

快速開始

分三步產生影片:建立任務、輪詢任務直到完成,然後取得結果。

1. 產生影片

curl -X POST https://api.deepmanim.com/api/v1/generate \
  -H "Authorization: Bearer dm_k_your_key" \
  -H "Content-Type: application/json" \
  -d '{"message": "解釋光合作用如何運作", "preferred_locale": "zh-TW"}'

2. 輪詢等待完成

curl https://api.deepmanim.com/api/v1/jobs/JOB_ID \
  -H "Authorization: Bearer dm_k_your_key"

# 回應包含:
#   status: "pending" | "running" | "completed" | "failed"
#   phase: "exploring_ideas" | "brainstorming" | "crafting_vision" | "refining_details" | "assembling_pieces" | "polishing" | "adding_voice" | "iterating" | "done"
#   estimated_time_remaining_seconds: 285

3. 取得結果

# 當 status 為 "completed" 時,回應包含:
{
  "job_id": "...",
  "status": "completed",
  "phase": "done",
  "estimated_time_remaining_seconds": 0,
  "result": {
    "video_url": "https://...",
    "description": "解釋光合作用的動畫……",
    "session_id": "...",
    "message_id": "...",
    "duration_seconds": 24.6,
    "has_audio": true,
    "follow_up": "細胞呼吸與光合作用有什麼關係?"
  }
}

端點

影片產生

任務

工作階段

訊息

帳戶

點數與價格

每次建立任務的 API 呼叫都會從餘額中扣除點數:

操作費用
產生影片最低 1.5 點數
改善影片最低 1.5 點數
新增音訊1 點數
改善旁白1 點數

產生和改善的費用取決於所選預設,目前為 1.5 到 70 點數。讀取工作階段、訊息、任務狀態和帳戶資訊免費,不會扣除點數。

錯誤回應

狀態意義
401缺少或無效的 API 金鑰
402點數不足
404找不到資源(工作階段、訊息或任務)
400請求無效(例如沒有可改善的影片,或沒有可最佳化的旁白)
API 文件 | DeepManim