Submit a render job

Body: {scene_id, kind: preview|final|info, frames: [..] (preview) or frame_start/frame_end (final), width, height, samples, engine: cycles|eevee, output: png|exr (frames) or mp4|webm|prores|gif|webp (video) or blend (the built scene as a .blend, not rendered, free), transparent (alpha background; png/exr/webm/gif/webp), notify_url (https; one JSON POST when the job finishes), fps, camera, environment: studio|sunset|overcast|night|compare, environment_strength, environment_visible, blender: 5.0|5.2, orbit, orbit_frames, orbit_elevation, orbit_target, orbit_distance, preset: product|turntable|animation (fills the camera, light, backdrop, frames and output for that purpose; what you pass wins)}. Returns job_id, status and eta.

post/v1/jobs

Request

  • Base URL: https://render.janction.jp
  • URL: https://render.janction.jp/v1/jobs
  • Auth: API key in header X-API-Key

Headers

x-api-keystring nullable

Request body

scene_idstring

from POST /v1/files, POST /v1/files/url or an earlier job; or send scene_script / scene_url instead

scene_scriptstring

the scene as bpy Python code (text), used when scene_id is absent

scene_urlstring uri

https link to a .blend, .py or 3D file, used when scene_id is absent

asset_urlsstring[]

extra files with scene_script / scene_url: https links or 'polyhaven:<id>' CC0 assets

kind'preview' | 'final' | 'info'
framesinteger[]

preview: 1-4 frame numbers

frame_startinteger
frame_endinteger

final: up to 3,000 frames per call (frame_start..frame_end); longer than 240 runs as parts under one job id

widthinteger

final: at most 1920x1080 pixels per frame on free time, 3840x2160 with prepaid credit; preview: scaled to 1280x720

heightinteger

final: at most 1920x1080 pixels per frame on free time, 3840x2160 with prepaid credit; preview: scaled to 1280x720

samplesinteger
fpsinteger
output'auto' | 'png' | 'exr' | 'mp4' | 'webm' | 'prores' | 'gif' | 'webp' | 'blend'
camerastring
camerasstring[]
environment'' | 'studio' | 'sunset' | 'overcast' | 'night' | 'compare'
environment_strengthnumber
environment_visibleboolean
blender'' | '5.0' | '5.2'
engine'' | 'cycles' | 'eevee'
transparentboolean
orbitboolean
orbit_framesinteger
orbit_elevationnumber
orbit_targetstring
orbit_distancenumber
preset'' | 'product' | 'turntable' | 'animation'
max_yeninteger

ceiling for this job; 0 = only if it fits the free time

notify_urlstring uri

https; one signed POST when the job finishes

Response

Successful Response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.