Create a new rendition.

post

https://example.com/authoring/v1/renditions

Use this endpoint to create a new rendition. The rendition will have resizing parameters applied before the crop is conducted. The generated rendition link will depend on the parameters provided. The scale parameter is required to resize. LocationX, locationY, width and height parameters are required to crop.
User roles: admin, manager, editor

Query Params

fields

array of strings

Only the rendition fields that are specified here are returned for each result. Any renditions field is a valid value and these can be specified in a comma-separated list. For example, to list the renditions fields name and ID, provide the value ID, and name. All renditions fields are returned by default.

fields

include

array of strings

Additional renditions fields that are specified here are returned. Currently, only the links field can be included. Fields are to be provided as a comma-separated list.

include

projectId

string

The id of the project that the rendition's underlying asset resides in. This property must be provided if the asset is in a project. This includes projects with id of "draft".

Body Params

Provide the data to create a rendition.

locationX

integer

Offset from the top left corner in the x dimension for where the crop will begin

locationY

integer

Offset from the top left corner in the y dimension for where the crop will begin

width

integer

Width of the crop

height

integer

Height of the crop

scale

number

Size image will be scaled to

asset

object

required

string

The id of the rendition to create

Responses

201Successfully created a new rendition.

400The required parameters are missing or invalid, or the number of allowed renditions have been reached. Please read the error message and alter the request accordingly.

409A rendition already exists with the given ID.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

503Connection failed to datastore.

defaultUnexpected error.