Upload Assets

Upload assets to project

OpenAPI spec

Upload asset(s)

This endpoint does not follow JSON:API spec by having brand ID as a path parameter instead of relationships object. The spec does not specify how to implement file upload endpoints. See https://github.com/json-api/json-api/issues/246

POST/api/v2/brands/{brandID}/assets

Path parameters

brandID*string (uuid)

Brand ID.

Body

multipart/form-data

filesarray of string (binary)

Response

201401404422

OK

Body

application/vnd.api+json

data*array of AssetData (object)

meta*AssetsMeta (object)

Request

JavaScriptCurl

const response = await fetch('/api/v2/brands/{brandID}/assets', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "data": [
    {
      "id": "a8e22ad3-b8b1-4fe2-a08a-45e5ba39df7d",
      "type": "assets",
      "attributes": {
        "name": "My Asset",
        "alt_text": "My Asset",
        "file_name": "my-asset.jpg",
        "path": "assets/43/43f6358e-dcbb-45f9-a9d7-25156a3f9707/orig",
        "thumbnail_path": "assets/43/43f6358e-dcbb-45f9-a9d7-25156a3f9707/thumbnail",
        "size": 123456,
        "mime_type": "image/jpeg",
        "image_width": 1920,
        "image_height": 1080,
        "created_at": "2021-01-01T00:00:00Z",
        "uploader_name": "John Doe",
        "uploader_email": "[e-mail]"
      },
      "relationships": {
        "asset_tags": {
          "data": [
            {
              "type": "asset_tags",
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        }
      }
    }
  ],
  "meta": {
    "page": {
      "current": 1,
      "total_pages": 13,
      "total_count": 1239,
      "per_page": 100
    }
  }
}

Example

Curl

curl -i -X POST \                                                                                                                                                                                                           17:52:24
  -H "Authorization: Bearer rJURvA6XuuHxG5RHauqR1yy64JQcTfGu" \
  -F "files=@/file/path/playerOne.jpeg" \
  -F "files=@/file/path/playerTwo.webp" \
  https://environment.monterosa.cloud/api/v2/projects/2dae6dc6-c2c5-4220-b69d-4bda57f79bf2/assets

Response

{
  "data": [
    {
      "attributes": {
        "created_at": "2023-12-21T18:01:14.981699+01:00",
        "file_name": "playerOne.jpeg",
        "image_height": 582,
        "image_width": 692,
        "mime_type": "image/jpeg",
        "name": "playerOne.jpeg",
        "path": "testtest/8f/8f735f8d-d959-4459-9b92-7099dddfa9f8/orig",
        "size": 186691,
        "thumbnail_path": "testtest/8f/8f735f8d-d959-4459-9b92-7099dddfa9f8/thumbnail"
      },
      "id": "8f735f8d-d959-4459-9b92-7099dddfa9f8",
      "type": "assets"
    },
    {
      "attributes": {
        "created_at": "2023-12-21T18:01:15.201353+01:00",
        "file_name": "playerTwo.webp",
        "image_height": 423,
        "image_width": 640,
        "mime_type": "image/webp",
        "name": "playerTwo.webp",
        "path": "testtest/a0/a04c3022-4769-4956-b4a2-dd6f229a42ef/orig",
        "size": 69201,
        "thumbnail_path": "testtest/a0/a04c3022-4769-4956-b4a2-dd6f229a42ef/thumbnail"
      },
      "id": "a04c3022-4769-4956-b4a2-dd6f229a42ef",
      "type": "assets"
    }
  ]
}