Upload images and files to Content Lake, and link Media Library assets to your dataset.
The assets endpoint is used to upload and interact with assets in Content Lake.
Assets API base URL
https://{projectId}.api.sanity.io/{apiVersion}/assets"v2024-06-24"API version
"your-project-id"Sanity project ID
/images/{dataset}Upload an image asset to Content Lake.
This uploads an image and creates a linked sanity.imageAsset document containing the image metadata.
Filename for this file (optional)
Optional title for the asset
Optional description for the asset
Array of metadata to extract from asset
["palette","lqip","blurhash"]Optional freeform label for the asset.
Optional request tag for the upload. Learn more in the request tag documentation.
The credit to person(s) and/or organization(s) required by the supplier of the asset to be used when published.
The name of the source if asset is from an external service.
Use with sourceName. The id of the asset within the external source.
Use with sourceName. The url of the asset within the external source.
image/*The image file to upload.
Upload successful
sanity.imageAssetThe CDN URL of the asset
https://cdn.sanity.io/images/myproject/mydataset/image-1234567890-500x400.jpgSize of the asset in bytes.
202546MIME type of the asset.
image/jpegjpgmy-image.jpgcd6b7eaf68c33e65ee6866873b9c0e48be84bb01Metadata extracted from the asset. Learn more in the metadata documentation.
sanity.imageMetadatasanity.imageDimensions5004001.25/files/{dataset}Upload an file asset to Content Lake.
This uploads an file and creates a linked sanity.fileAsset document containing the file metadata.
Filename for this file (optional)
Optional title for the asset
Optional description for the asset
Optional freeform label for the asset.
Optional request tag for the upload. Learn more in the request tag documentation.
The credit to person(s) and/or organization(s) required by the supplier of the asset to be used when published.
The name of the source if asset is from an external service.
Use with sourceName. The id of the asset within the external source.
Use with sourceName. The url of the asset within the external source.
image/*The file binary to upload.
Upload successful
sanity.fileAssethttps://cdn.sanity.io/files/myproject/mydataset/openAPISpec.yamlSize of the asset in bytes.
202546MIME type of the asset.
image/jpegjpgmy-image.jpgcd6b7eaf68c33e65ee6866873b9c0e48be84bb01/media-library-link/{dataset}Creates a linked Media Library asset in your dataset. To support features like preview,
Media Library assets need to be linked to a local asset document.
Pair with mutate to attach linked Media Library assets to documents.
application/jsonThe asset ID of the Media Library asset. This comes from the asset._id field
returned as part of the response when uploading an asset to the library.
The id of the Media Library.
The asset instance ID of the Media Library asset. This comes from the assetInstance._id field
returned as part of the response when uploading an asset to the library.
Link created successfully