projects

MP4 レンダーを開始（Remotion Lambda・非同期・5cr）

Changed on
post/api/v1/projects/{projectId}/render

Request

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

Path parameters

projectIdstring required

Request body

outputFormat'landscape' | 'portrait'

使わなくてよい。向きは platform で決まる（platform を省き、プロジェクトにも向きが無いときだけ portrait=縦型として扱う）

platform'youtube' | 'tiktok' | 'shorts'

向きと用途。shorts / tiktok は縦型。省略するとプロジェクトを作ったときの platform（GET /projects/{id} の project.platform）

codec'h264' | 'vp8' | 'vp9'
waitForCompletionboolean

非推奨・無視される（2026-09-15）。true でも待たずに、常に status:"rendering" と renderId を返すので、進捗（GET .../render/{renderId}/progress、MCP なら get_render）で完了を追う。送っても 400 にはならない。

fontSizenumber
titleFontSizenumber
voicePlaybackRatenumber

動画全体の読み上げの再生速度（0.5〜2.0。既定 1.1）。焼くときと共有リンクで音声の再生に掛かる（音声の作り直しは要らない）。プロジェクトの voice_playback_rate に残り、共有リンク・あとの render も同じ速さになる。行ごとの速さ・高さは script[].voice（掛け合わせ）。省略するとプロジェクトの値（無ければ 1.1）。渡すとプロジェクトにも残る。焼かずに変えるなら PATCH /api/v1/projects/{projectId}/settings。

bgmVolumenumber
showOutroCardboolean
materialImageFilterstring[]

素材画像にかけるフィルタ。未指定ならプロジェクトの設定を使う

titlestring

動画内に出すタイトル（プロジェクト名と別にしたいとき）

callbackUrlstring uri

完了/失敗したらここへ POST する。https のみ・内部アドレス不可（弾いた場合は課金せず 400）。本文は {event, projectId, renderId, status, downloadUrl?, occurredAt}。X-Yukkurigen-Signature: t=<unix秒>,v1=HMAC-SHA256(callbackSecret, "<t>.<本文>") を検証すること。callbackSecret はこの応答で返る（利用者ごとに固定）。t が現在時刻から5分以上離れていたら捨てること。

idempotencyKeystring

冪等キー（任意）。Idempotency-Key ヘッダと同じ働きで、ヘッダが無いときに使われる。同じ鍵で投げ直せば最初の結果が返り、課金は起きない（24時間）。処理中なら 409 code:"in_flight"。

Response

開始。常に status:"rendering" と renderId を返す——waitForCompletion を付けても待たずに status: rendering で返る（非推奨・無視）。200 は完了ではないので、進捗（GET .../render/{renderId}/progress）で完了を追うこと。

renderIdstring
status'rendering'
callbackUrlstring

登録された通知先（指定した場合のみ）。

callbackSecretstring

署名の検証に使う鍵（callbackUrl を指定した場合のみ返る。利用者ごとに固定）。

callbackSignatureHeaderstring

署名が載るヘッダ名。

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 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_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 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 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

    • 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

    • 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