POST /assets

1 min

POST

https://api.cmp.optimizely.com/v3/assets

Create a new asset. Supports only images, videos, and raw files. See Upload assets to upload an asset.

Body Parameters

bodyLibraryAssetCreateRequestrequired
Description
Payload to create an asset
- keystringrequired
  Description
  Unique identifier of the file upload session. This is the upload_meta_fields.key field retrieved from the /v3/upload-url endpoint.
  Max Length
  100
- titlestringrequired
  Example
  sample_image.png
  Description
  Title of the asset
  Min Length
  1
  Max Length
  100
- folder_idstring
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  ID of the folder where the asset should be added

Responses

201Created asset

AssetResponse
- idstringrequired
  Example
  5d7f910551b00a722e0418830cee6631
  Description
  Unique identifier for the asset
- titlestringrequired
  Example
  sample_image.png
  Description
  Title of the asset
- typestring<article | image | video | raw_file | structured_content | compose_content>required
  Example
  image
  Description
  Type of the asset
  Allowed
  articleimagevideoraw_filestructured_contentcompose_content
- mime_typestringrequired
  Example
  image/png
  Description
  MIME type of the asset
- file_extensionstringrequired
  Example
  png
  Description
  File extension of the asset
- created_atstring<date-time>required
  Example
  2019-10-06T13:15:30Z
  Description
  Date and time on which the asset was created, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- modified_atstring<date-time>required
  Example
  2019-10-07T13:15:30Z
  Description
  Date and time of the most recent modification of the asset, in ISO 8601 UTC format (2020-02-10T10:40
  )
  Format
  date-time
- folder_idstringrequired
  Example
  6bb8db20a5b611ebae319b7c541b1a5a
  Description
  ID of the folder containing the asset in the library
- file_locationstringrequired
  Example
  /all assets/important assets
  Description
  Location of the folder containing the asset in the library
- is_archivedbooleanrequired
  Description
  Whether the asset is archived or not
- contentAssetContentrequired
  Description
  Content of the asset
  - typestring<url | api_url | html_body>required
    Example
    url
    Description
    Type of the content.
    
    article – html_body
    
    image, raw_file, video – url
    
    structured_content – api_url
    
    compose_content – api_url
    Allowed
    urlapi_urlhtml_body
  - valuestringrequired
    Example
    http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
    Description
    Content of the asset. - article – the html body - image, raw_file, video – the download URL - structured_content – api url - compose_content – api url
- labelsResourceLabelResponse[]required
  Description
  Labels associated with the asset
  - groupobjectrequired
    Description
    Label group
    - idstringrequired
      Example
      2467e583a60e23fda2b89db81a453cd2
      Description
      Identifier of the label group
    - namestringrequired
      Example
      Content Format
      Description
      Name of the label group
  - valuesobject[]required
    Description
    List of values of the label
    - idstringrequired
      Example
      71c378f3fee3d822759d1bdc2aab628c
      Description
      Identifier of the label value
    - namestringrequired
      Example
      Photos
      Description
      Name of the label value
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/images/5d7f910551bw0a722e0418830cee6631
    Description
    URL of the asset (only GET is supported)
- owner_organization_idstringrequired
  Example
  5108c3a9becac35915111191
  Description
  ID of the asset's owner organization
- thumbnail_urlstringrequired
  Example
  https://images1.cmp.optimizely.com/Pz1kYmI9Z2FkYTJtZWI5VGI1WZq4MTZkNTdmGHjM5OGRmYq==
  Description
  URL of the asset's thumbnail

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

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/assets \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "key": "",
     "title": "sample_image.png"
     }'

javascript

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

var raw = JSON.stringify({
   "key": "",
   "title": "sample_image.png"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/assets", 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/assets")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "key": "",
   "title": "sample_image.png"
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/assets"

payload = json.dumps({
   "key": "",
   "title": "sample_image.png"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Created asset
{
  "id": "5d7f910551b00a722e0418830cee6631",
  "title": "sample_image.png",
  "type": "image",
  "mime_type": "image/png",
  "file_extension": "png",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "folder_id": "6bb8db20a5b611ebae319b7c541b1a5a",
  "file_location": "/all assets/important assets",
  "is_archived": false,
  "content": {
    "type": "url",
    "value": "http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S"
  },
  "labels": [
    {
      "group": {
        "id": "2467e583a60e23fda2b89db81a453cd2",
        "name": "Content Format"
      },
      "values": [
        {
          "id": "71c378f3fee3d822759d1bdc2aab628c",
          "name": "Photos"
        }
      ]
    }
  ],
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/images/5d7f910551bw0a722e0418830cee6631"
  },
  "owner_organization_id": "5108c3a9becac35915111191",
  "thumbnail_url": "https://images1.cmp.optimizely.com/Pz1kYmI9Z2FkYTJtZWI5VGI1WZq4MTZkNTdmGHjM5OGRmYq=="
}

400

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

401

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

403

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