GET /renditions/{id}

1 min

GET

https://api.cmp.optimizely.com/v3/renditions/{id}

Experimental Get a rendition given its id.

Path Parameters

idstringrequired
Example
c2603a6e0b4811eebea95edf08e23f48
Description
Unique identifier of the rendition

Responses

200Details of the rendition

DetailedAssetRenditionResponse
- objectBaseAssetRenditionResponse
  - idstringrequired
    Example
    5d7f910551b00a722e0418830cee6631
    Description
    Unique identifier of the rendition
  - namestringrequired
    Example
    Facebook
    Description
    Name of the rendition
  - created_atstring<date-time>required
    Example
    2022-09-27T08:18:41Z
    Description
    Date and time on which the rendition was created, in ISO 8601 UTC format
    Format
    date-time
  - mime_typestringrequired
    Example
    image/png
    Description
    MIME type of the rendition
  - urlstringrequired
    Example
    https://files.cmp.optimizely.com/download/6ceee2f4fa3411ecb37802420ac8001b
    Description
    URL of the rendition
- object
  - modified_atstring<date-time>required
    Example
    2022-09-27T09:14:30Z
    Description
    Date and time on which the rendition was last modified, in ISO 8601 UTC format
    Format
    date-time
  - widthintegerrequired
    Example
    600
    Description
    The width (in pixels) of the rendition
  - heightintegerrequired
    Example
    400
    Description
    The height (in pixels) of the rendition
  - alt_textstringrequired
    Example
    image title
    Description
    Alternative text for rendition
  - original_asset_idstringrequired
    Example
    5d7f910551b00a722e0418830cee6631
    Description
    ID of the original asset the rendition was generated from
  - rendition_config_idstring
    Example
    f910551b00ae0418830cee6631452651
    Description
    ID of rendition config used to generate the rendition
  - asset_typestringrequired
    Example
    image
    Description
    Type of the original asset the rendition was generated from
  - statusstring<Done | InProgress | Error>required
    Example
    Done
    Description
    Status of the rendition's generation
    Allowed
    DoneInProgressError

400Client error

Error
Example
```
{
  "message": "Unsupported arguments: a,b,c"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url https://api.cmp.optimizely.com/v3/renditions/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/renditions/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/renditions/{id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/renditions/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Details of the rendition
{
  "id": "5d7f910551b00a722e0418830cee6631",
  "name": "Facebook",
  "created_at": "2022-09-27T08:18:41Z",
  "mime_type": "image/png",
  "url": "https://files.cmp.optimizely.com/download/6ceee2f4fa3411ecb37802420ac8001b",
  "modified_at": "2022-09-27T09:14:30Z",
  "width": 600,
  "height": 400,
  "alt_text": "image title",
  "original_asset_id": "5d7f910551b00a722e0418830cee6631",
  "rendition_config_id": "f910551b00ae0418830cee6631452651",
  "asset_type": "image",
  "status": "Done"
}

400

// Client error
{
  "message": "Not found",
  "errors": ""
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}