Documentation
Discussions

Create Layer

post
https://preview.threekit.com/api/layers

Creates a layer and generates an id which can be used to retrieve the layer, also supports saving an uploaded GLTF or USDZ file(with the fileId being the id of the uploaded file) as a layer.

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

Private token used to authorize the request. This endpoint is only accessible using a private token.

string

Name of the org branch to connect to. If no value is provided the default value is "main".

Body Params

Layer creation information.

string
required

Asset ID.

assetLayerConfiguration
object
required

Configuration of the asset layer. If the asset has no composition(related to layered rendering), the assetLayerConfiguration is the configuration of the asset in question.

string

ID of the corresponding layer in the composite asset. Not required if no comp asset is present.

string
required

Organization which owns the layer.

string

Stage ID.

stageConfiguration
object

Configuration of the stage.

metadata
object

Metadata of the layer representing the cropping and offset information for the image.

string

Job ID of the job that created the layer. This is automatically set by the system when the render is generated by the platform.

string

Task ID of the job task that created the layer. This is automatically set by the system when the render is generated by the platform.

string
required

File ID of the file stored in the file service that you want to associate with this layer.

integer
required

Width of the image in pixels. This should represent the full intended render width, not the cropped width.

integer
required

Height of the image in pixels. This should represent the full intended render height, not the cropped height.

Responses

Updated about 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 about 1 year ago