Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Paste your API key as the CMS showed it: fsk_<site>_<key id>_<secret> (issued under API Keys). ApiKey in front of it works too. Leave it empty to read as the public.

Scopes

images:read

Path Parameters

id
string
required

The image’s document ID, its slug, or its exact title (case-insensitive), tried in that order.

Response

The image.

One image from the Images library.

_id
string | null
required

The image’s document ID (aposDocId).

slug
string | null
required

Reference an image in an MDX import by it.

title
string | null
required

Its title.

alt
string
required

Alt text; empty when none is set.

folderPath
string | null
required

The media folder it sits in.

width
integer | null
required

Pixels.

height
integer | null
required

Pixels.

extension
string | null
required

File extension, e.g. jpg.

bytes
integer | null
required

Size of the original file.

urls
object
required

A URL per rendered size.