Update a rendition

PUT

/api/renditions/{configId}/{assetId}

const url = 'https://example.com/api/renditions/example/example';
const form = new FormData();
form.append('file', 'example');
form.append('rendition', 'example');

const options = {method: 'PUT', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/renditions/example/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=example \
  --form rendition=example

Updates an existing rendition for a content item. Requires multipart/form-data with ‘file’ and ‘rendition’ (JSON) fields.

Authorizations

bearerAuth

Parameters

Path Parameters

configId

required

Repository configuration ID

string

assetId

required

Asset ID

string

Request Body

multipart/form-data

object

file

Rendition file

rendition

required

JSON string with rendition metadata (name, type)

string

Responses

200

Rendition updated successfully

application/json

object

name

required

Rendition name

string

type

required

Rendition type

string

format

File format/extension

string

url

required

URL to access the rendition

string

storage

Storage details

object

objectName

required

Storage object name

string

version

Storage version ID

string | null

objectName

Object storage name

string

mimeType

MIME type

string

size

File size in bytes

number

fileName

Original file name

string

Example

{
  "name": "native",
  "type": "native",
  "format": "jpg",
  "url": "/api/assets/repo/item123/native",
  "mimeType": "image/jpeg",
  "size": 1024,
  "fileName": "image.jpg"
}

400

Invalid request

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}

404

Item not found

application/json

object

error

required

Indicates an error occurred

boolean

message

required

Error message describing what went wrong

string

Example

{
  "error": true,
  "message": "Item not found"
}