Render Verzoek

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

Opmerking: Onze renderverzoeken worden asynchroon verwerkt. Na het indienen van een verzoek ontvangt u onmiddellijk een reactie met een render_id, die kan worden gebruikt om de status en resultaten van de rendering op te vragen.

EigenschapTypeVereistVoorbeeldWaardenbereikOmschrijving
compositeWidthnumbertrue1920720 - 3840De breedte van de composiet.
compositeHeightnumbertrue1080720 - 3840De hoogte van de composiet.
fpsnumbertrue3015 - 60De frame rate van de composiet.
projectDataobjecttrue--De projectgegevens. Kan worden geëxporteerd vanuit de editor.
cameraobjectfalse--Optionele cameraconfiguratie voor 3D-scènes. Beheert de projectiemodus en kijkhoek.

Opmerking: De compositeWidth en compositeHeight kunnen verschillen van de width en height die zijn opgegeven in projectData. De beeldverhouding van compositeWidth tot compositeHeight moet echter consistent blijven met de beeldverhouding van projectData.width tot projectData.height.

Dit ontwerp maakt het mogelijk om hetzelfde videoproject in verschillende resoluties te exporteren terwijl de oorspronkelijke beeldverhouding behouden blijft.

Camera Configuratie

Het optionele camera object controleert hoe 3D-elementen worden geprojecteerd:

  • mode (string) - Projectiemodus: "perspective" (standaard) of "orthographic". Perspectief biedt diepte-gebaseerde verkorting; orthografisch behoudt parallelle lijnen.
  • view (string) - Een vooraf ingestelde camerastandpuntnaam (bijv. "front", "top", "right", "isometric"). Wanneer opgegeven, wordt de camera gepositioneerd om de vooraf ingestelde hoek te matchen.

Als er geen camera wordt opgegeven, wordt het standaard perspectief frontview gebruikt.

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

Succes Render Reactie

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

Fout Render Reactie

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

Reactie Codes

Hier zijn de codes die door de asynchrone rendering API worden geretourneerd:

  • 0: Succes – Het asynchrone renderverzoek is succesvol ingediend.
  • 2001: Parameterfout – Het verzoek bevat ongeldige of ontbrekende parameters.
  • 2002: Gebruiker niet geregistreerd – De opgegeven gebruikers-ID bestaat niet.
  • 2003: Gebruiker is geen API-lid en kan geen renderingdiensten gebruiken.
  • 2004: Ongeldige projectgegevens – Het projectData veld is geen geldig JSON-object.
  • 2005: Renderbalans niet voldoende – Onvoldoende saldo om door te gaan met renderen.
  • 2006: Mislukt om projectgegevens te marshallen – Kon projectgegevens niet naar JSON converteren.
  • 2007: Mislukt om JSON-gegevens te uploaden – Fout opgetreden tijdens het uploaden van projectgegevens.
  • 2008: Mislukt om rendergegevens te marshallen – Renderverzoekpayload kon niet worden geserialiseerd.
  • 2009: Mislukt om renderverzoek te verzenden – Fout opgetreden tijdens het verzenden van het verzoek.
  • 2010: Ontbrekend duur veld – Het duration veld is vereist maar ontbreekt.
  • 2011: Ongeldig duur veld – Het duration veld is aanwezig maar niet in het juiste formaat.
  • 2012: Renderdienst mislukt – De renderingdienst heeft een interne fout ondervonden.

Als u een foutcode tegenkomt die niet is vermeld, neem dan contact op met de ondersteuning via [email protected].

Verkrijg Render Resultaat

Na het indienen van een asynchroon renderverzoek, kunt u de render_id gebruiken om de status en het resultaat van de rendering op te vragen.

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

Verzoekparameters

EigenschapTypeVereistVoorbeeldWaardenbereikOmschrijving
render_idnumbertrue100000-De render ID die is geretourneerd van het initiële renderverzoek.

Succes Render Reactie

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 Statussen

Het state veld in de reactie kan de volgende waarden hebben:

  • pending: Het renderverzoek staat in de wachtrij en wacht op verwerking
  • rendering: De render wordt momenteel verwerkt
  • success: De render is succesvol voltooid en de video is klaar
  • failed: De render is mislukt vanwege een fout

Verwijder Renderbestanden

Gebruik dit eindpunt om het gerenderde videobestand en project-JSON permanent te verwijderen voor een voltooide taak.

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

Verzoekparameters

EigenschapTypeVereistVoorbeeldWaardenbereikOmschrijving
render_idnumbertrue100000-De render ID die u wilt opruimen. Alleen renders in de successtatus kunnen worden verwijderd.

Voorbeeld Reactie

delete_response.json
{
"code": 0,
"data": {
  "message": "Render files deleted"
},
"msg": "success"
}
  • De verwijderactie is onomkeerbaar en verwijdert zowel de video als de JSON-activa.
  • Verzoeken voor renders die nog in behandeling zijn, aan het renderen zijn of zijn mislukt, worden afgewezen.