ReelaDocs

自動化

透過 Reela CLI 完成訂閱建立影片,並將完成的結果連結至你的工作流程

透過 Reela CLI 完成訂閱建立影片,並將完成的結果連結至你的工作流程。

Reela 提供影片製作指令,以及用於接收已完成影片的完成訂閱。代理或其他工具可以提交影片需求,並透過 CLI 背景常駐程式接收輸出,無須讓 Reela 網站保持開啟。

從需求到影片

create 可將文字需求和選用媒體轉換為影片任務。你可以直接提供提示詞或從檔案讀取提示詞、選擇影片長度和版面配置、加入虛擬化身,並附上參考圖片、影片素材或背景音樂。

reela create --prompt-file brief.txt \
  --visual ai-video --layout portrait --duration 30 \
  --session "Product campaign" --output json

影片生成是一項長時間執行的任務。請先啟動背景常駐程式並設定完成訂閱,再提交任務;Reela 會在背景執行生成作業,並將完成的結果傳送給你的指令碼。重複使用工作階段標題會將相關影片歸入同一個專案。如需設定方式,請參閱下方的自動傳送。

提交之前,請先加入 --dry-run,以驗證請求並預覽預估點數,且不會上傳檔案或建立任務。提交任務可能會消耗點數。

請參閱影片建立選項,了解支援的視覺內容和媒體輸入。

透過等級選擇畫質和費用

等級可讓你為每個請求選擇生成選項。Reela 會提供說明,協助你或代理根據預期結果選擇合適的選項,並在提交前估算該請求所需的點數。

reela tiers list
reela tiers list --output json

清單會顯示每個等級的標籤和說明,並指出預設選項。在 JSON 輸出中,tiers 會包含含有 label、content 和 is_default 的項目;default_tier 則會標示預設選項。請閱讀 content,了解各選項的差異,而不是依照它們在清單中的位置來選擇。列出等級不代表你的帳戶一定能使用所有選項;Reela 會在驗證或提交請求時檢查存取權限。

請將確切的標籤傳給 --tier。將下方的 <tier-label> 替換成清單中的標籤;如果標籤含有空格,請保留引號:

reela create --prompt-file brief.txt --visual ai-video \
  --tier "<tier-label>" --duration 30 --layout portrait \
  --dry-run --output json

預覽會回傳 credits_cost 和 quota_after。若要提交,請移除 --dry-run,並保留選取的等級和其他選項。等級代表一種生成選擇;請使用預覽來估算實際請求的費用。

如果省略 --tier,Reela 會使用 CLI 目前可用的預設選項。如果沒有可用的預設選項,請執行 reela tiers list 以更新選項,或明確指定等級。明確選擇等級可讓你的工作流程選項不受預設值變更影響;但可用性和定價仍可能變動。列出、預覽和提交時,請使用相同的設定檔。

請參閱等級指令參考,了解輸出詳細資訊和選擇方式。

為代理和工具提供結構化結果

--output json 會以結構化資料提供指令結果,包括等級選項、點數估算和提交確認。結束碼 0 表示指令成功;發生錯誤時會使用非零結束碼,並在 stderr 輸出純文字,包括 JSON 模式也是如此。

成功提交後,背景常駐程式會負責等待任務完成,並呼叫你訂閱的指令碼,傳入結果。提交回應和完成事件都包含 task_id,讓你的工作流程能將完成的影片與原始需求關聯起來。

自動傳送

Reela CLI 可以在影片任務完成時執行你自己的可執行檔。這項完成訂閱會將 Reela 的輸出連結至你的下一個動作:將影片交給發布工具、更新記錄,或通知其他系統。Reela 會監控任務是否完成,並將任務詳細資料提供給你的指令碼。

註冊你的指令碼

請提供執行 Reela CLI 的電腦上可執行檔的絕對路徑。指令碼可使用任何語言,只要能從 stdin 讀取事件,並透過結束碼回報成功即可。

reela subscribe add script --path /absolute/path/on-video \
  --timeout-seconds 300 --max-retries 3

每個設定檔只能訂閱一個指令碼。若要變更現有訂閱所使用的可執行檔,請使用 reela config set delivery.script.path /absolute/path/on-video。變更訂閱或其設定後,請重新啟動已在執行的背景常駐程式,如下所述。

接收完成事件

Reela 會啟動可執行檔,並將一個 JSON 物件寫入 stdin:

{
  "event": "task.completed",
  "task_id": "12345",
  "status": "completed",
  "status_label": "completed",
  "title": "Product demo",
  "description": "A short product introduction",
  "download": {
    "filename": "product-demo.mp4",
    "download_url": "https://example.com/video.mp4"
  }
}

使用 task_id 將事件連結至原始提交。title、description 和 download 可能是 null。若有提供,download 會提供已完成影片的建議檔名和下載 URL,供你的指令碼直接使用。若缺少 download 值,請先處理此情況,再執行需要影片的動作。

簽署的 download_url 連結會在產生後 6 小時失效。收到完成事件後,請盡快下載影片或將其複製到你自己的儲存空間。請妥善保管下載 URL,並將其視為臨時存取連結,而非永久影片網址。

此訂閱會接收所選帳戶中已完成的任務,包括在 CLI 以外建立的影片。如果你的動作屬於特定工作流程,請將事件中的任務 ID 與你提交的任務比對。完成訂閱目前僅處理成功完成的任務;失敗、取消或部分完成的任務不會觸發此事件。

執行與重試

  • **成功:**動作成功後,以 0 結束。Reela 會捨棄指令碼的 stdout,不會將列印的輸出作為結果使用。
  • 逾時:--timeout-seconds 300 允許每次呼叫最多執行 300 秒。逾時或以非零結束碼結束都會使傳送失敗。
  • **重試:**Reela 會重試失敗的傳送。若只有指令碼方法失敗,--max-retries 3 允許總共嘗試三次,包括首次嘗試。涉及其他已啟用方法的失敗則使用 delivery.max_retries。
  • **重複傳送:**請確保針對相同的 task_id 重複執行時仍安全,避免再次呼叫時重複發布同一部影片,或重複新增相同記錄。

保持訂閱持續運作

CLI 背景常駐程式會處理完成事件,並執行你啟用的傳送方式。選好傳送方式後,請啟動背景常駐程式並檢查傳送狀態:

reela daemon start
reela subscribe status

新增傳送方式時,也會嘗試啟動已停止的背景常駐程式。如果背景常駐程式已在執行,請在變更傳送設定後重新啟動,讓設定生效。若是手動啟動的背景常駐程式,請先使用 reela daemon stop,再使用 reela daemon start。

Reela 會儲存傳送進度,並在背景常駐程式重新啟動時從該進度繼續處理。若沒有已儲存的進度,預設會從新事件開始處理。若沒有已儲存的進度,reela daemon start --keep-backlog 也會處理仍可取得的先前已完成任務事件。

使用 reela daemon install 啟用登入時啟動。如果已安裝為服務,請在變更設定後透過作業系統的服務管理員重新啟動服務。使用 reela daemon status 或 reela daemon logs --tail 50 檢查傳送狀態。

自動傳送要求執行背景常駐程式的電腦保持開機並連線。請在提交影片之前啟動背景常駐程式,這樣影片完成時才會觸發你的指令碼。

Linux 和 macOS 上可使用 daemon 和 subscribe。Windows x64 支援影片指令、狀態查詢和手動下載。

選用的下載和電子郵件傳送

你可以在指令碼之外,啟用自動下載或已完成影片的電子郵件通知。預設傳送設定會啟用下載;請使用 reela config set delivery.download ~/Videos/reela 設定目的地。若已停用,請使用 reela subscribe add download --dir ~/Videos/reela 啟用。請使用 reela subscribe add email 啟用電子郵件,也可選擇加入 --address me@example.com,以使用不同於帳戶電子郵件的地址。

多種方式可以同時啟用,而且其中一種方式失敗不會阻止其他方式執行。每次指令碼呼叫都會收到自己的完成內容,其中包含可用的下載資訊。請參閱傳送指令參考,了解所有傳送方式。

重複使用你的製作設定

Reela 還提供其他可納入工作流程的功能:

  • **維持品牌一致性:**使用 brand list 列出現有品牌套件,並使用 brand apply 將其中一個套用至任務。此指令會等待套用品牌後的輸出。請參閱品牌指令。
  • **以程式編輯:**使用 edit 下載編輯 JSON、驗證變更、儲存草稿以供預覽,並提交算繪。請參閱編輯指令。
  • **分開管理帳戶和偏好設定:**使用 --profile 或 REELA_PROFILE 選取設定檔。傳送方式和設定會套用至所選的設定檔。請參閱設定檔和組態。

例如,產品影片工作流程可以提交附有參考圖片的需求,並透過背景常駐程式的完成訂閱,將完成的影片交給發布工具。Reela 會在背景生成影片並傳送完成通知;你的工具則決定何時提交,以及收到結果後要採取什麼動作。

請參閱傳送指令參考,了解所有訂閱和背景常駐程式選項。如需安裝和帳戶授權資訊,請從開始使用著手。