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

get

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

Authorizations

cookieAuthtokenAuth

sessionidstringRequired

Path parameters

frbr_uristringRequired

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

Query parameters

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

Responses

200Success

application/json

get

/v3/{frbr_uri}/media

HTTPcURLJavaScriptPython

GET /v3/{frbr_uri}/media HTTP/1.1
Host: 
Accept: */*

200Success

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

Download a media file

get

Download a media file.

Authorizations

cookieAuthtokenAuth

sessionidstringRequired

Path parameters

filenamestringRequiredPattern: ^.*$

frbr_uristringRequired

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

Responses

200Success

application/json

get

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

HTTPcURLJavaScriptPython

GET /v3/{frbr_uri}/media/{filename} HTTP/1.1
Host: 
Accept: */*

200Success

binary