Render an Asset with WebGL

post

https://preview.threekit.com/api/asset-jobs/{assetId}/render/webgl/image

Renders an asset using WebGL. 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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

assetId

string

required

AssetID

Query Params

cache

boolean

Caches the file created.

wait

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.

bearer_token

string

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

Body Params

Render information.

orgId

string

Organization which owns the asset or product to render.

configuration

object

Specify a specific configuration of the asset or product to be rendered

stageId

string

Scene ID to be used as a stage for renders

stageConfiguration

object

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

sync

boolean

If the request has the sync option set, it will wait for the job to finish and then return
the results (jobId and job details). Otherwise it will return only the jobId.

settings

object

Default settings for a render request. Unspecified attributes will use the default values.

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Asset render job was started.

401Unauthorized to make the request.

422Malformed request, render job couldn't start.