Get Layer by Query Parameters

Retrieves a layer by query parameters. This API route also allows making use of Thumbor to optimize images. ** NOTE - Thumbor does not work for AR exports results stored in layers-service.** If multiple layers match the latest one is returned. This API endpoint cannot be used to fetch on-demand composite results. To do that please use the fast-compositor API.

Query Params
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.

string

ID of a asset

string

Asset layer

string

Configuration of an asset layer. If the asset has no composition(related to layered rendering), the assetLayerConfiguration is the configuration of the asset in question. Must be passed in as by encoding the stringified JSON.

string

Hash of the asset layer configuration to query by. NOTE - This hash is generated by the system and cannot be calculated outside of the platform.

string

Stage ID

string

Configuration of the stage. Must be passed in as a stringified ad encoded JSON.

string

Hash of the stage configuration to query by. NOTE - This hash is generated by the system and cannot be calculated outside of the platform.

string

Metadata of the stage. Must be passed in as a stringified and encoded JSON.

string

When set to "file" the response will be the associated file's contents if present. When set to "url" the response will contain the API URL to fetch the file. When set to "url" the response will contain the uto download the file, along with any metadata associated with it

string

This will include parameters related to thumbor optimization. The parameter must be a stringified and encoded JSON. The available options are -

  1. format - Specify the format to which the image should be converted. Currently only supports converting an image to "webp". Should be a string
  2. quality - Specify the compression level to be used in thumbor. The value can be anything between 0 and 100. Should be a number
  3. width - Specify the width to crop the image to. Should be a number
  4. height - Specify the height to crop the image to. Should be a number
string

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

Responses

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