Creates Composite Image

get

https://preview.threekit.com/api/fast-compositor/

This service will allow you to create composite images. The results will get saved permanently in the layers system in addition to getting cached.

Query Params

assetId

string

required

ID of asset to be composited.

orgId

string

required

ID of org that owns asset.

stageId

string

ID of stage for asset.

configuration

string

Encoded, stringified configuration object for asset.

stageConfiguration

string

Encoded, stringified configuration object for stage.

cacheKey

string

Cache key.

cacheMaxAge

integer

Maximum cache age.

height

integer

Composite image height.

width

integer

Composite image width.

cropHeight

number

0 to 1

The ratio which will be used for width of the final cropped image.

cropWidth

number

0 to 1

The ratio which will be used for height of the final cropped image.

cropX

number

0 to 1

The ratio which will be used for the starting position of the crop on the x axis.

cropY

number

0 to 1

The ratio which will be used for the starting position of the crop on the y axis.

format

string

enum

Format type for composited image.

Allowed:

imageFitMode

string

enum

Fit mode for composited image.

Allowed:

bearer_token

string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token. A public token has read-only permissions whereas a private token has read and write permissions.

display

string

enum

Defaults to image

Allows users to specify the the player type (2D or 3D) to take snapshot from. Currently only supports two values - webgl and image. Default value is image.

Allowed:

publishFileId

string

ID of the static publish to help the fast-compositor service take an snapshot faster.

skipResolveTags

boolean

Defaults to true

Skip resolving values of an attribute in a configurator. This is to speed up the response time of the service by avoiding unnecessary API calls. BY default this is set to true.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful get request, body of response will be generated composite image.

401User has not authenticated and must authenticate before using this service

403User has authenticated but lacks authorization to use this service