API reference
Help centerCommunityDevelopersAcademyStatus

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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
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.

integer

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

integer

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

integer

Width of the crop

integer

Height of the crop

number

Size image will be scaled to

asset
object
required
string

The id of the rendition to create

Responses

Updated 3 months ago

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

Updated 3 months ago