Skip to main content

In your app

A controller answers a route on your app: it calls getMediaImage() and returns the answer.

Add the controller

app/controllers/get_media_image_controller.ts

Add the route

start/routes.ts

Call it

Terminal
With node ace serve running, it prints its answer as JSON.

Required parameters

One object, e.g. getMediaImage({ id }); leave out the optional fields.
string
required
Required. The image’s document ID, its slug, or its exact title (case-insensitive), tried in that order.
A MediaImage. One image from the Images library. Read its properties (mediaImage.id): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, two-thirds → twoThirds, one-half → oneHalf …).
string | null
Always sent, can be null. The image’s document ID (aposDocId).
string | null
Always sent, can be null. Reference an image in an MDX import by it.
string | null
Always sent, can be null. Its title.
string
Always sent. Alt text; empty when none is set.
string | null
Always sent, can be null. The media folder it sits in.
number | null
Always sent, can be null. Pixels.
number | null
Always sent, can be null. Pixels.
string | null
Always sent, can be null. File extension, e.g. jpg.
number | null
Always sent, can be null. Size of the original file.
MediaImageUrls
Always sent. A MediaImageUrls. A URL per rendered size.
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.
400
The request is not valid.Retried first: No. Read: errors (field → messages), siteMessage.
401
The API key is missing, malformed, unknown, disabled, expired or archived, or a request its signing mode requires to be signed is not.Retried first: No. Read: siteMessage, errorName, data.
403
The API key lacks the scope this route needs, is used from outside its allowlist, or the caller is anonymous.Retried first: No. Read: siteMessage, errorName, data.
404
Nothing matches the identifier.Retried first: No. Read: siteMessage, errorName, data.
429
The key used up its reads-per-minute limit. Still, after the client’s own waits and retries.Retried first: Yes: the client waits Retry-After (1 s when absent; over 60 s it gives up at once) and retries, up to retries times (2 by default). Read: retryAfter (seconds, or null), siteMessage.
5xx
The site failed (or something in front of it did). Its logs say why.Retried first: A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. Read: siteMessage, errorName, data.
no answer
No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Yes, after 0.5 s then 1 s. Read: reason, neverConnected.
not sent
The client refused to send it (e.g. a path segment of ..); the site never saw it.Retried first: No. Read: reason (what to change).
any other
Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read: reason, status.
setup
sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.
setup
The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with images:read — or media:all, or admin:all — or any signed-in CMS user (who sees only what they may view). Anonymous callers get 403.
  • Retries: a read is safe to repeat: the client retries it on no answer, a 502/503/504 and a 429.
  • Timeout: 15 s per attempt by default; raise timeout (milliseconds) in config/attract.ts for longer.

More examples

Test it

It calls the controller above with the SDK faked: fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/fetchski_media_get_media_image.spec.ts, then run your tests:
tests/unit/fetchski_media_get_media_image.spec.ts
Terminal
Answer with your own values: fake fetchskiMedia.getMediaImage with factories.MediaImage({...}), the fields you give over a valid example.
tests/unit/fetchski_media_get_media_image_answers.spec.ts

List images

site.fetchskiMedia().listMediaImages()

List videos

site.fetchskiMedia().listMediaVideos()

Get one video

site.fetchskiMedia().getMediaVideo()

GET /fetchski-media/images/{id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.