Render Request

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

Nota: Nostri rendering petitiones asyncronice processantur. Post submissionem petitionis, statim responsum accipies continens render_id, quod adhiberi potest ad status et eventus rendering interrogandum.

ProprietasTypusRequiriturExemplumAmbitus ValorisDescriptio
compositeWidthnumbertrue1920720 - 3840Latitudo compositi.
compositeHeightnumbertrue1080720 - 3840Altitudo compositi.
fpsnumbertrue3015 - 60Rate frame compositi.
projectDataobjecttrue--Data project. Ex editor exportari potest.
cameraobjectfalse--Configuratio camera optativa pro scaenis 3D. Moderatur modum projectionis et angulum visum.

Nota: compositeWidth et compositeHeight ab width et height in projectData specificatis differre possunt. Tamen, ratio aspectus inter compositeWidth et compositeHeight constans manere debet cum ratione aspectus inter projectData.width et projectData.height.

Haec consilium permittit ut idem video projectum in diversis resolutionibus exportetur, dum originalis ratio aspectus servatur.

Camera Configuration

Objectum camera optativum moderatur quomodo elementa 3D proiecta sunt:

  • mode (string) - Modus projectionis: "perspective" (default) vel "orthographic". Perspectiva profunditatem basata foreshortening praebet; orthographic lineas parallelas servat.
  • view (string) - Nomen praestitutum camerae visum (exempli gratia, "front", "top", "right", "isometric"). Cum specificatum est, camera ad angulum praestitutum collocatur.

Si nulla camera praebetur, visus frontalis perspectiva default adhibetur.

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 Render Response

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

Error Render Response

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

Response Codes

Hic sunt codices a API rendering asyncronico redditi:

  • 0: Successus – Petitio rendering asyncronica feliciter submissa est.
  • 2001: Error parametri – Petitio continet invalidos vel desinentes parametros.
  • 2002: Usor non registratus – Praebitum ID usoris non existit.
  • 2003: Usor non est membrum API et non potest officia rendering uti.
  • 2004: Data project invalidum – Campus projectData non est validum obiectum JSON.
  • 2005: Saldo rendering non satis – Saldo insufficient ad procedendum cum rendering.
  • 2006: Defecit ad marshaling data project – Non potuit converti data project ad JSON.
  • 2007: Defecit ad upload JSON data – Error occurrit dum data project uploadatur.
  • 2008: Defecit ad marshaling data rendering – Payload petitionis rendering non potuit serializari.
  • 2009: Defecit ad mittendum petitionem rendering – Error occurrit dum petitio mittitur.
  • 2010: Campus durationis desit – Campus duration requiritur sed desit.
  • 2011: Campus durationis invalidus – Campus duration praesens est sed non in forma recta.
  • 2012: Servitium rendering defecit – Servitium rendering errorem internum incurrit.

Si error codex non enumeratus occurrit, quaeso contactum auxilium ad [email protected].

Get Render Result

Post submissionem petitionis rendering asyncronicae, potes uti render_id ad interrogandum status et eventum rendering.

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}'

Request Parameters

ProprietasTypusRequiriturExemplumAmbitus ValorisDescriptio
render_idnumbertrue100000-ID rendering redditum ex initiali petitione rendering.

Success Render Response

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"
}

Render States

Campus state in responsione has sequentia valores:

  • pending: Petitio rendering in ordine est et exspectat ut processetur
  • rendering: Rendering in praesenti processatur
  • success: Rendering feliciter completum est et video paratum est
  • failed: Rendering defecit ob errorem

Delete Render Files

Utere hoc endpoint ad video file et project JSON permanenter tollendum pro facto opere.

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}'

Request Parameters

ProprietasTypusRequiriturExemplumAmbitus ValorisDescriptio
render_idnumbertrue100000-ID rendering quem vis purgare. Tantum renderings in statu successu deleri possunt.

Sample Response

delete_response.json
{
"code": 0,
"data": {
  "message": "Render files deleted"
},
"msg": "success"
}
  • Actio delenda irreversibilis est et amovet tam video quam JSON assets.
  • Petitiones pro rendering quae adhuc pendent, rendering, vel defecerunt reiciuntur.