Home
Content Management API
Main resources
Upload-related
Site Search
Environments
UI
Workflows
Async jobs
Roles & permissions
Webhooks
Hosting & CI integrations
Subscription
Enterprise
Show examples in:
Upload

Every file you upload to DatoCMS will be retrievable from this endpoint.

Object payload

id  string
RFC 4122 UUID of upload expressed in URL-safe base64 format
type  string
Must be exactly "upload"
size  integer  Example: 444

size of the upload

width  null, integer  Example: 30

Width of image

height  null, integer  Example: 30

Height of image

path  string  Example: "/45/1496845848-digital-cats.jpg"

Upload path

basename  string  Example: "digital-cats"

Upload basename

filename  string  Example: "digital-cats.jpg"

Upload filename

url  string  Example: "https://www.datocms-assets.com/45/1496845848-digital-cats.jpg"

Upload URL

format  string, null  Example: "jpg"

Format

author  string, null  Example: "Mark Smith"

Author

copyright  string, null  Example: "2020 DatoCMS"

Copyright

notes  string, null  Example: "Nyan the cat"

Notes

md5  string  Example: "873c296d0f2b7ee569f2d7ddaebc0d33"

The MD5 hash of the asset

duration  integer, null  Example: 62

Seconds of duration for the video

frame_rate  integer, null  Example: 30

Frame rate (FPS) for the video

blurhash  string, null  Example: "LEHV6nWB2yk8pyo0adR*.7kCMdnj"

Blurhash for the asset

thumbhash  string, null  Example: "UhqCDQIkrHOfVG8wBa2v39z7CXeqZWFLdg=="

Base64 encoded ThumbHash for the asset

mux_playback_id  string, null  Example: "a1B2c3D4e5F6g7H8i9"

Public Mux playback ID. Used with stream.mux.com to create the source URL for a video player.

mux_mp4_highest_res  enum, null  Example: "high"

Maximum quality of MP4 rendition available

default_field_metadata  object  Example: {"en":{"title":"this is the default title","alt":"this is the default alternate text","custom_data":{"foo":"bar"},"focal_point":{"x":0.5,"y":0.5}}}

For each of the project's locales, the default metadata to apply if nothing is specified at record's level.

is_image  boolean  Example: true

Is this upload an image?

created_at  null, date-time

Date of upload

updated_at  null, date-time

Date of last update

mime_type  null, string  Example: "image/jpeg"

Mime type of upload

tags  Array<string>  Example: ["cats"]

Tags

smart_tags  Array<string>  Example: ["robot-cats"]

Smart tags

exif_info  object  Example: {"iso":10000,"model":"ILCE-7","flash_mode":16,"focal_length":35,"exposure_time":0.0166667}

Exif information

colors  Array<object>  Example: [{"red":206,"green":203,"blue":167,"alpha":255},{"red":158,"green":163,"blue":93,"alpha":255}]

Dominant colors of the image

creator{ type: "account", id: account.id }, { type: "access_token", id: access_token.id }, { type: "user", id: user.id }, { type: "sso_user", id: sso_user.id }, { type: "organization", id: organization.id }

The entity (account/collaborator/access token) who created the asset. It must be an object with type (e.g. 'account') and id properties.

upload_collection{ type: "upload_collection", id: upload_collection.id }, null

Upload collection to which the asset belongs

Available endpoints

Did this doc help you?
Still need help?
Explore our forum, contact support, or connect with our sales team. You can also chat live with other users in our Slack channel.