HTTP endpoints reference for the Media Library API
The Media Library endpoint is used to interact with assets and documents in Media Libraries.
Media Library API base URL
https://api.sanity.io/{apiVersion}/media-libraries/{mediaLibraryId}"v2025-02-19"API version
"your-media-library-id"Media Library ID
*/*The file to upload
/mutateMutate a document in the Media Library.
This uses the same mutation syntax as Content Lake's Mutation API.
application/jsonMutation successful
/queryUse GROQ to query the Media Library.
See the GROQ documentation for more information on writing GROQ queries.
OK
The GROQ query and projection executed against the Media Library.
The result of the query. The type of the result depends on the query response.
For example, if the query returns a single document, the result will be an object. If it returns a list of documents, the result will be an array.
A list of sync tags. Sync tags are used with the Live Content API to track document changes.
/references/documents/{assetId}/toGet references to an asset document from other documents and datasets. At this time, this does not support draft or version documents.
Note: this endpoint is currently only available on version vX of the API.
The ID of the asset to get references for.
A cursor to paginate through the results.
The cursor is returned in the nextCursor field of the response.
OK
The global document reference ID of the document that references the asset.
This is made up of the {resourceName}:{resourceId}.{dataset}:{documentId}.
dataset:y3d2bw.production:document-id1234A list of field path locations in the document that reference the asset.
["mainImage.media._ref","body[4].media._ref"]Total number of references found
Cursor for paginating to next set of results
application/json{
"references": [
{
"sourceDocumentRef": "dataset:y856rro4.production:196167ef-8c0b-4d7c-ae18-71179e424c19",
"sourceFieldPaths": [
"mainImage.media._ref"
]
},
{
"sourceDocumentRef": "dataset:y856rro4.production:503cceed-a1b5-4552-9cc1-c6fddf28de59",
"sourceFieldPaths": [
"body[4].media._ref"
]
},
{
"sourceDocumentRef": "dataset:y856rro4.production:drafts.196167ef-8c0b-4d7c-ae18-71179e424c19",
"sourceFieldPaths": [
"gdrImage._ref",
"mainImage.media._ref"
]
}
],
"totalCount": 3,
"nextCursor": "gdr1:eyJucyI6Ink4NTZycm80LnByb2R1Y3Rpb24uS2RSS2c4Z0tJQVFhIiwiaWQiOiJkcmFmdHMuMTk2MTY3ZWYtOGMwYi00ZDdjLWFlMTgtNzExNzllNDI0YzE5In0"
}