Skip to main content

In your app

A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.

Add the function

src/attract/get-media-video.ts

Call it

A script makes the client once and calls the function:
scripts/get-media-video.ts
Terminal
A route handler, a job or a queue worker calls it the same way.

Required parameters

One object, e.g. getMediaVideo({ id }); leave out the optional fields.
string
required
Required. The video’s document ID, its slug, or its exact title (case-insensitive), tried in that order.
A MediaVideo. One video from the Videos library. Read its properties (mediaVideo.id): each says whether the site always sends it. The example answer is the site’s wire JSON: one key differs from the property names (_id → id).
string | null
Always sent, can be null. The video’s document ID (aposDocId).
string | null
Always sent, can be null. Reference a video in an MDX import by it.
string | null
Always sent, can be null. Its title.
string | null
Always sent, can be null. The media folder it sits in.
string | null
Always sent, can be null. File extension, e.g. mp4.
number | null
Always sent, can be null. Size of the file.
string | null
Always sent, can be null. The video file.
string | null
Always sent, can be null. The poster image, when one is set.
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below; catch only what you want to react to (see Errors and testing).
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 your sites (createSiteClients()) don’t have.Retried first: No: nothing was sent. Read: message, slug.
setup
The client’s settings are wrong: no FETCHSKI_ATTRACT_URL (or baseUrl), or a malformed API key.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with videos: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) on the client for longer.

More examples

Test it

It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it with node --test.
tests/fetchskiMedia-getMediaVideo.test.ts

List images

site.fetchskiMedia().listMediaImages()

List videos

site.fetchskiMedia().listMediaVideos()

Get one image

site.fetchskiMedia().getMediaImage()

GET /fetchski-media/videos/{id}

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