Documentation
Discussions

Render an Asset with VRay

post
https://preview.threekit.com/api/asset-jobs//render/vray/image

Renders an asset using VRay. To render a product, replace asset ID with the product ID in the url. This API allows for passing a stage ID as well as a stage configuration as optional parameters, to render products or assets with a specific scene(called stage).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

AssetID

Query Params
boolean

Caches the file created.

boolean

It will query for the latest version of the file. If the latest version is not available, it will serve an older version and queue a job for the new one. If no version is available, it will create one and send it back in the response. This parameter will only work in conjunction with the cache parameter. It has no effect if the cache parameter is not present in the request.

string

Access token used to authorize the request. This endpoint only works with private tokens.

Body Params

Render information.

string

Organization which owns the item to render.

configuration
object

Specify a configuration of the item or layer to be rendered.

string

Stage ID to be used as a stage for renders.

stageConfiguration
object

Specify a configuration of the stage, to be used for renders.

string

Specify if the renders should use WebGL or VRay. If this parameter is not provided, the API automatically defaults to webGL renders.

string

If specified, it will render all possible combinations of that layer. If a configuration is specified in the request, it will only render that configuration for the layer

configurations
array of objects

Can be used to render all configurations provided in the request. This parameter is an array of configuration objects.

configurations
subset
object

Parameter to allow rendering subset of attribute values

Responses

Updated over 1 year ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago