> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one video

> One video by its ID, slug or exact title.

```ts TypeScript wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const mediaVideo = await site.fetchskiMedia().getMediaVideo({ id: 'clx8m2k4p0000a1b2c3d4e5f6' });
```

```json 200 wrap theme={"dark"}
{
  "_id": "clx8k2m0a0002abcd1234efgh",
  "slug": "video-product-tour",
  "title": "Product tour",
  "folderPath": "Marketing",
  "extension": "mp4",
  "bytes": 18430211,
  "url": "https://cdn.example.com/attachments/def456-product-tour.mp4",
  "poster": "https://cdn.example.com/attachments/ghi789-tour-poster.full.jpg"
}
```

## 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.

**1. Add the function**

```ts src/attract/get-media-video.ts theme={"dark"}
import type { SiteClient } from '@fetchski/attract-cms-sdk';

export async function getMediaVideo(site: SiteClient, id: string) {
  return site.fetchskiMedia().getMediaVideo({ id });
}
```

**2. Call it**

A script makes the client once and calls the function:

```ts scripts/get-media-video.ts theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';
import { getMediaVideo } from '../src/attract/get-media-video.ts';

const site = createSiteClient();
console.log(await getMediaVideo(site, 'clx8m2k4p0000a1b2c3d4e5f6'));
```

```bash Terminal theme={"dark"}
node --env-file=.env scripts/get-media-video.ts
```

A route handler, a job or a queue worker calls it the same way.

> [accordion] Required parameters
>
> One object, e.g. `getMediaVideo({ id })`; leave out the optional fields.
>
> **id** `string` *required*
>
> **Required.** The video’s document ID, its slug, or its exact title (case-insensitive), tried in that order.

> [accordion] Returns
>
> 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`).
>
> **id** `string | null`
>
> **Always sent, can be `null`.** The video’s document ID (aposDocId).
>
> **slug** `string | null`
>
> **Always sent, can be `null`.** Reference a video in an MDX import by it.
>
> **title** `string | null`
>
> **Always sent, can be `null`.** Its title.
>
> **folderPath** `string | null`
>
> **Always sent, can be `null`.** The media folder it sits in.
>
> **extension** `string | null`
>
> **Always sent, can be `null`.** File extension, e.g. `mp4`.
>
> **bytes** `number | null`
>
> **Always sent, can be `null`.** Size of the file.
>
> **url** `string | null`
>
> **Always sent, can be `null`.** The video file.
>
> **poster** `string | null`
>
> **Always sent, can be `null`.** The poster image, when one is set.

> [accordion] Errors
>
> 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](https://docs.fetchski-attract.com/typescript/errors.md)).
>
> **ValidationFailed** `400`
>
> The request is not valid.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `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`.
>
> **Forbidden** `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`.
>
> **NotFound** `404`
>
> Nothing matches the identifier.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **RateLimited** `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`.
>
> **SiteError** `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`.
>
> **SiteUnreachable** `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`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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`.
>
> **UnknownSite** `setup`
>
> `sites.forSite('acme')` named a slug your sites (`createSiteClients()`) don’t have.
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `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

```ts Or null wrap theme={"dark"}
import { createSiteClient } from '@fetchski/attract-cms-sdk';

const site = createSiteClient();
const mediaVideo = await site.fetchskiMedia().findMediaVideo({ id: 'clx8m2k4p0000a1b2c3d4e5f6' }); // MediaVideo | null: null when the site answers 404
```

## 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`.

```ts tests/fetchskiMedia-getMediaVideo.test.ts theme={"dark"}
import { test } from 'node:test';
import { fakeSite } from '@fetchski/attract-cms-sdk/testing';
import { getMediaVideo } from '../src/attract/get-media-video.ts';

test('fetchskiMedia.getMediaVideo', async () => {
  const site = fakeSite();
  await getMediaVideo(site, 'clx8m2k4p0000a1b2c3d4e5f6');
  site.assertCalled('fetchskiMedia.getMediaVideo', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6');
});
```

## Related

> [card] [List images](https://docs.fetchski-attract.com/typescript/reference/fetchski-media/list-media-images.md)
>
> `site.fetchskiMedia().listMediaImages()`

> [card] [List videos](https://docs.fetchski-attract.com/typescript/reference/fetchski-media/list-media-videos.md)
>
> `site.fetchskiMedia().listMediaVideos()`

> [card] [Get one image](https://docs.fetchski-attract.com/typescript/reference/fetchski-media/get-media-image.md)
>
> `site.fetchskiMedia().getMediaImage()`

> [card] [GET /fetchski-media/videos/\{id}](https://docs.fetchski-attract.com/api-reference/fetchski-media/get-one-video.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.