Next (Commands) Previous (Exporting)







URL Parameters

  • uuid: the scene ID.

Optional Query Parameters

These parameters can be used to override the settings within the scene file.

  • renderer: vray or webgl. If not supplied, will be used to determine the appropriate renderer.
  • time: the frame number to render
  • pass: the name of the pass containing the render options
  • width, height: width & height of the desired image. If not specified, either the general renderer settings or pass overrides are used.
  • url: true or false, defaults to false. Only available on the synchronous API. Determines if the result upon success is an image (a binary) or an URL to that image.
  • setupCommand: a command to be executed before rendering. The command must be in the form {plugin}%2f{command}, where “%2f” is equivalent to ‘/’. for example, vray/sceneSetup can be used to ensure that the scene contains lights and cameras.
  • data: optional data for setupCommand. It is available in the plugin command via options.get('data').

WebGL specific options:

  • azimuthAngle: override camera positioning
  • polarAngle: override camera positioning
  • boundingRadius: override camera positioning
  • subd: boolean, if enabled, will add MeshSmooth operator to all meshes.

The v2 WebGL renderer is always used. V1 WebGL rendering can only be done via the editor.

V-Ray specific options:

  • gi: optional control over global illumination. Use values "on“ or ”off". Global illumination can take a long time. To get faster result, use this option to turn it off.
  • cameraNode: optional camera to use when rendering. This parameter supports the name or the id (ex.: f3408a7d-0d8f-44c1-ad3e-03f2a985320a). If the camera uses special characters in its name, use the hexadecimal code (ex. ‘/’ and ‘%2f’, ‘@’ and ‘%40’, ‘:’ and ‘%3a’).
  • cameraType: optional camera type to render the scene:
    • default (default value)
    • spherical
    • box
    • fisheye
    • orthogonal
  • fov: optional field of view of the camera if cameraType is used. The angle value must be between 0 and 360. If not used, the default value is the field of view of the camera in the scene used to render.
  • quality: optional quality level:
    • basic
    • standard
    • high
    • maximum
  • gamma: the gamma correction value. Default is 2.2. To disable gamma correction use the value of 1.0

Output format

The output format is specified by the renderer used. V-Ray's default format is JPEG. WebGL v2 only outputs PNG.

Alternatively you can send a Accept: text/event-stream header to receive an event stream of the render job and its progress.

Asynchronous Example

See the Asynchronous Operations documentation for asynchronous examples in several languages.

Synchronous Example

These are examples of the synchronous (blocking) interface.

Rendering at frame 17:

curl "" \
    -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b \
    > MyScene.jpg

Rendering with a 360 spherical camera without global illumination:

curl "" \
  -u username:c3be3060-fe81-467b-aa62-0ee42eea9c8b \
  > MyScene.jpg

Clara Node SDK

When using the Clara Node SDK:

$ clara scenes:render [options]

Next (Commands) Previous (Exporting)