POST /tasks/{id}/assets

1 min

POST

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

This API allows you to add an asset to a task. There currently two mechanisms to add an asset - either by uploading an asset first and then calling this API (for only images, videos, and raw files), or by adding an asset from the library. The 'type' parameter in the request body will determine the mechanism used to add the asset. See Upload assets to upload an asset.

Path Parameters

idstringrequired
Example
5f857f30e1c4a2038d6179e9
Description
Unique identifier of the task

Body Parameters

bodyTaskAssetRequestrequired
Description
Payload to add an asset. There are two mechanisms for adding assets to a task:
- direct_upload - An asset that has been uploaded using the Upload assets endpoint.
- fork_from_library - This will fork an existing asset from the library to the task. The type field is optional, and will default to direct_upload if not provided. Note: Renditions is currently not supported for library assets.
- objectTaskAssetRequestForDirectUpload
  - typestring
    Example
    direct_upload
    Description
    The mechanism for adding the asset to the task
  - 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
- objectTaskAssetRequestForLibrary
  - typestringrequired
    Example
    fork_from_library
    Description
    The mechanism for adding the asset to the task
  - content_idstring<uuid>required
    Example
    d1efd3c4625111f0baa002420ac8001d
    Description
    Unique identifier of the asset
    Format
    uuid
  - content_typestring<article | image | raw_file | structured_content | video>required
    Example
    image
    Description
    The type of asset
    Allowed
    articleimageraw_filestructured_contentvideo

Responses

201Created asset

TaskAssetResponse
- 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
- 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
- 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/tasks/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631
    Description
    URL of the asset
  - taskstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
    Description
    URL of the task that the asset is associated with
  - draftsstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6631/drafts
    Description
    URL to POST draft to the asset - null for article - non-null for image, video, and raw file.
  - web_urlsobjectrequired
    Description
    Web URLs
    - selfstringrequired
      Example
      https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6631
      Description
      Web URL of the asset
    - taskstringrequired
      Example
      https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
      Description
      Web URL of the task that the asset is associated with
    - draftsstringrequired
      Example
      https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631
      Description
      Web URL of the drafts of the asset - null for article - non-null for image, video, and raw file.

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

422Unprocessable entity error

Error
Example
```
{
  "message": "Resource cannot be processed"
}
```
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/tasks/{id}/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/tasks/{id}/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/tasks/{id}/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/tasks/{id}/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",
  "created_at": "2019-10-06T13:15:30Z",
  "modified_at": "2019-10-07T13:15:30Z",
  "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/tasks/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631",
    "task": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9",
    "drafts": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6631/drafts",
    "web_urls": {
      "self": "https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6631",
      "task": "https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9",
      "drafts": "https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631"
    }
  }
}

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": ""
}

422

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