Embedded images

Fetch metadata and files for images embedded in the content of a work expression.

Some documents include images. The media API includes metadata for these images, and provides a mechanism to fetch the images from the API so that you can store them and serve them to your users when they view the content.

List media files for a work expression

API for fetching media files (usually images) embedded in a document.

GET/v3/{frbr_uri}/media

Authorization

cookieAuthtokenAuth

Path parameters

frbr_uri*string

The FRBR URI of the work or work expression, without the first slash, such as akn/za/act/1994/2/

Query parameters

Response

200

Body

application/json

countinteger

Example: 123

nextnullable string

previousnullable string

resultsarray of MediaAttachment (object)

Request

JavaScriptCurlPython

const response = await fetch('/v3/{frbr_uri}/media', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "count": 123,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "url": "https://example.com",
      "filename": "text",
      "mime_type": "text"
    }
  ]
}

Download a media file

Download a media file.

GET/v3/{frbr_uri}/media/{filename}

Authorization

cookieAuthtokenAuth

Path parameters

filename*string

Pattern: ^.*$

frbr_uri*string

The FRBR URI of the work or work expression, without the first slash, such as akn/za/act/1994/2/

Response

200

Body

application/json

string (binary)

Request

JavaScriptCurlPython

const response = await fetch('/v3/{frbr_uri}/media/{filename}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

binary