projects

MP4 レンダー進捗＋出力URL

Changed on
get/api/v1/projects/{projectId}/render/{renderId}/progress

Request

  • Base URL: https://app.yukkurigen.com
  • URL: https://app.yukkurigen.com/api/v1/projects/{projectId}/render/{renderId}/progress
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

projectIdstring required
renderIdstring required

Response

進捗

doneboolean

レンダーが終了したか。成功とは限らない — 失敗（チャンク欠落、および後追いで確定した分）でも true になる。必ず失敗判定を先に行うこと。

overallProgressnumber
outputFilestring nullable

成功時のみ非空。成功条件は done===true かつ outputFile が非空。

fatalErrorEncounteredboolean

true なら失敗が確定（リトライ不能）。done より先にこれを見ること。

retriedboolean

Lambda 側の一時的な失敗（強制終了・素材の取得の停止・AWS の容量不足や頻度の上限）で、サーバが自動で1回焼き直したか。焼き直している間は done:false・fatalErrorEncountered:false のまま進捗が 0 から数え直すので、ポーリングを続けること。クレジットは押さえたまま（追加の消費なし）。焼き直しも失敗したら fatalErrorEncountered が立ち、返金される。

renderIdstring

このレンダーのID（リクエストの renderId と同じ）。

creditsstring

完成したとき（done かつ outputFile）だけ。YouTube の概要欄に貼るクレジット（使った声・素材の表記。VOICEVOX の表記は利用規約の条件）。MCP の get_render も同じ値を返す。upload（YouTube 投稿）は自動で足す

Changes

  • ba5f36b016daRevision changes
    • warning

      added the new already_subscribed enum value to the response property for the response status

    • warning

      added the new already_subscribed enum value to the response property for the response status

    • warning

      added the new already_subscribed enum value to the response property for the response status

    • warning

      added the new already_subscribed enum value to the response property for the response status

    • warning

      added the new already_subscribed enum value to the response property for the response status

    • warning

      added the new already_subscribed enum value to the response property for the response status

    • warning

      added the new render_not_paid enum value to the response property for the response status

    • warning

      added the new render_not_paid enum value to the response property for the response status

    • warning

      added the new render_not_paid enum value to the response property for the response status

    • warning

      added the new render_not_paid enum value to the response property for the response status

    • warning

      added the new render_not_paid enum value to the response property for the response status

    • warning

      added the new render_not_paid enum value to the response property for the response status

    • warning

      added the new render_not_ready enum value to the response property for the response status

    • warning

      added the new render_not_ready enum value to the response property for the response status

    • warning

      added the new render_not_ready enum value to the response property for the response status

    • warning

      added the new render_not_ready enum value to the response property for the response status

    • warning

      added the new render_not_ready enum value to the response property for the response status

    • warning

      added the new render_not_ready enum value to the response property for the response status

    • warning

      added the new tts_quota_exceeded enum value to the response property for the response status

    • warning

      added the new tts_quota_exceeded enum value to the response property for the response status

    • warning

      added the new tts_quota_exceeded enum value to the response property for the response status

    • warning

      added the new tts_quota_exceeded enum value to the response property for the response status

    • warning

      added the new tts_quota_exceeded enum value to the response property for the response status

    • warning

      added the new tts_quota_exceeded enum value to the response property for the response status

    • warning

      added the new youtube_not_connected enum value to the response property for the response status

    • warning

      added the new youtube_not_connected enum value to the response property for the response status

    • warning

      added the new youtube_not_connected enum value to the response property for the response status

    • warning

      added the new youtube_not_connected enum value to the response property for the response status

    • warning

      added the new youtube_not_connected enum value to the response property for the response status

    • warning

      added the new youtube_not_connected enum value to the response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status