レンダーリクエスト

curl-example.sh
curl -X POST https://render-api.chillin.online/render/v1 \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d @request.json

注意: 私たちのレンダリングリクエストは非同期で処理されます。リクエストを送信すると、すぐに render_id を含む応答が返されます。これを使用してレンダリングのステータスと結果を照会できます。

プロパティタイプ必須値の範囲説明
compositeWidthnumbertrue1920720 - 3840合成の幅。
compositeHeightnumbertrue1080720 - 3840合成の高さ。
fpsnumbertrue3015 - 60合成のフレームレート。
projectDataobjecttrue--プロジェクトデータ。エディターからエクスポートできます。
cameraobjectfalse--3Dシーンのオプションのカメラ設定。投影モードと視点を制御します。

注意: compositeWidthcompositeHeightprojectData で指定された widthheight とは異なる場合があります。ただし、compositeWidthcompositeHeight のアスペクト比は、projectData.widthprojectData.height のアスペクト比と一致している必要があります。

この設計により、元のアスペクト比を維持しながら、同じビデオプロジェクトを異なる解像度でエクスポートできます。

カメラ設定

オプションの camera オブジェクトは、3D要素がどのように投影されるかを制御します:

  • mode (文字列) - 投影モード: "perspective" (デフォルト) または "orthographic"。パースペクティブは深さに基づく短縮を提供し、オルソグラフィックは平行線を保持します。
  • view (文字列) - プリセットカメラビュー名 (例: "front", "top", "right", "isometric")。指定された場合、カメラはプリセット角度に合わせて配置されます。

camera が提供されない場合、デフォルトのパースペクティブ前面ビューが使用されます。

request.json
{
"compositeWidth": 1920,
"compositeHeight": 1080,
"fps": 30,
"projectData": {
  "type": "",
  "width": 1920,
  "height": 1080,
  "fill": "#000000",
  "view": [
    {
      "id": "8ecf7475-2c6c-47f9-827b-a09c7913f4c0",
      "type": "Image",
      "start": 0,
      "duration": 5,
      "trackIndex": 0,
      "x": -570.0335392757963,
      "y": -170.90659033307685,
      "blendMode": "normal",
      "anchorX": 1302,
      "anchorY": 2312,
      "rotation": 0,
      "scaleX": 0.23356401384083045,
      "scaleY": 0.23356401384083045,
      "alpha": 1,
      "skewX": 0,
      "skewY": 0,
      "keyframes": [],
      "externalUrl": "https://images.pexels.com/photos/30465303/pexels-photo-30465303.jpeg",
      "ext": "jpeg"
    }
  ],
  "audio": [],
  "effect": [],
  "transition": [],
  "version": 0,
  "duration": 5
}
};

成功したレンダー応答

success_response.json
{
"code": 0,
"data": {
  "message": "Async render request submitted successfully",
  "render_id": 105586,
  "status": "processing"
},
"msg": "success"
}

エラーのレンダー応答

error_response.json
{
"code": 2004,
"data": {},
"msg": "invalid project data: invalid view array: view item 0: missing required field: id"
}

応答コード

非同期レンダリングAPIから返されるコードは次のとおりです:

  • 0: 成功 – 非同期レンダーリクエストが正常に送信されました。
  • 2001: パラメーターエラー – リクエストに無効または欠落しているパラメーターがあります。
  • 2002: ユーザーが登録されていない – 提供されたユーザーIDは存在しません。
  • 2003: ユーザーはAPIメンバーではなく、レンダリングサービスを使用できません。
  • 2004: 無効なプロジェクトデータ – projectData フィールドは有効なJSONオブジェクトではありません。
  • 2005: レンダーバランスが不足 – レンダリングを進めるための残高が不足しています。
  • 2006: プロジェクトデータのマシャルに失敗しました – プロジェクトデータをJSONに変換できませんでした。
  • 2007: JSONデータのアップロードに失敗しました – プロジェクトデータのアップロード中にエラーが発生しました。
  • 2008: レンダーデータのマシャルに失敗しました – レンダーリクエストペイロードをシリアライズできませんでした。
  • 2009: レンダーリクエストの送信に失敗しました – リクエストの送信中にエラーが発生しました。
  • 2010: デュレーションフィールドが欠落しています – duration フィールドは必須ですが、欠落しています。
  • 2011: 無効なデュレーションフィールド – duration フィールドは存在しますが、正しい形式ではありません。
  • 2012: レンダーサービスが失敗しました – レンダリングサービスで内部エラーが発生しました。

リストにないエラーコードが発生した場合は、[email protected] までサポートにお問い合わせください。

レンダー結果を取得

非同期レンダーリクエストを送信した後、render_id を使用してレンダリングのステータスと結果を照会できます。

get-result-example.sh
curl -X POST https://render-api.chillin.online/render/result \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"render_id": 100000}'

リクエストパラメーター

プロパティタイプ必須値の範囲説明
render_idnumbertrue100000-最初のレンダーリクエストから返されたレンダーID。

成功したレンダー応答

result_response.json
{
"code": 0,
"data": {
  "render": {
    "create_at": "2025-06-27T12:37:21.684337Z",
    "json_url": "https://cloud.chillin.online/project_xxx.json?verify=xxx",
    "render_id": 105549,
    "state": "success",
    "video_url": "https://cloud.chillin.online/video_xxx.mp4?verify=xxx"
  }
},
"msg": "success"
}

レンダー状態

応答の state フィールドは次の値を持つことができます:

  • pending: レンダーリクエストはキューに入っており、処理を待っています
  • rendering: レンダーが現在処理中です
  • success: レンダーが正常に完了し、ビデオの準備が整いました
  • failed: レンダーがエラーにより失敗しました

レンダーファイルを削除

このエンドポイントを使用して、完了したタスクのレンダリングされたビデオファイルとプロジェクトJSONを永久に削除します。

delete-render-files.sh
curl -X POST https://render-api.chillin.online/render/delete-files \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{"render_id": 100000}'

リクエストパラメーター

プロパティタイプ必須値の範囲説明
render_idnumbertrue100000-クリーンアップしたいレンダーID。成功状態のレンダーのみ削除できます。

サンプル応答

delete_response.json
{
"code": 0,
"data": {
  "message": "Render files deleted"
},
"msg": "success"
}
  • 削除アクションは元に戻せず、ビデオとJSONアセットの両方を削除します。
  • 保留中、レンダリング中、または失敗したレンダーのリクエストは拒否されます。