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

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

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const mediaImage = await site.fetchskiMedia().getMediaImage({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
```

```json 200 wrap theme={"dark"}
{
  "_id": "clx8k2m0a0001abcd1234efgh",
  "slug": "image-team-at-work",
  "title": "Team at work",
  "alt": "Three people around a table with laptops",
  "folderPath": "Marketing/Team",
  "width": 2400,
  "height": 1600,
  "extension": "jpg",
  "bytes": 845210,
  "urls": {
    "original": "https://cdn.example.com/attachments/abc123-team-at-work.original.jpg",
    "max": "https://cdn.example.com/attachments/abc123-team-at-work.max.jpg",
    "full": "https://cdn.example.com/attachments/abc123-team-at-work.full.jpg",
    "two-thirds": "https://cdn.example.com/attachments/abc123-team-at-work.two-thirds.jpg",
    "one-half": "https://cdn.example.com/attachments/abc123-team-at-work.one-half.jpg",
    "one-third": "https://cdn.example.com/attachments/abc123-team-at-work.one-third.jpg",
    "one-sixth": "https://cdn.example.com/attachments/abc123-team-at-work.one-sixth.jpg"
  }
}
```

## In your app

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

**1. Add the controller**

```ts app/controllers/get_media_image_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class GetMediaImageController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.fetchskiMedia().getMediaImage({ id: params.id })
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const GetMediaImageController = () => import('#controllers/get_media_image_controller')

router.get('/fetchski-media/images/:id', [GetMediaImageController])
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:3333/fetchski-media/images/clx8m2k4p0000a1b2c3d4e5f6
```

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

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

> [accordion] Returns
>
> 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` …).
>
> **id** `string | null`
>
> **Always sent, can be `null`.** The image’s document ID (aposDocId).
>
> **slug** `string | null`
>
> **Always sent, can be `null`.** Reference an image in an MDX import by it.
>
> **title** `string | null`
>
> **Always sent, can be `null`.** Its title.
>
> **alt** `string`
>
> **Always sent.** Alt text; empty when none is set.
>
> **folderPath** `string | null`
>
> **Always sent, can be `null`.** The media folder it sits in.
>
> **width** `number | null`
>
> **Always sent, can be `null`.** Pixels.
>
> **height** `number | null`
>
> **Always sent, can be `null`.** Pixels.
>
> **extension** `string | null`
>
> **Always sent, can be `null`.** File extension, e.g. `jpg`.
>
> **bytes** `number | null`
>
> **Always sent, can be `null`.** Size of the original file.
>
> **urls** `MediaImageUrls`
>
> **Always sent.** A `MediaImageUrls`. A URL per rendered size.
>
> **MediaImageUrls**
>
> **original** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.
>
> **max** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.
>
> **full** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.
>
> **twoThirds** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.
>
> **oneHalf** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.
>
> **oneThird** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.
>
> **oneSixth** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Format: an absolute URL.

> [accordion] Errors
>
> 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](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **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 `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`.
>
> **SiteConfigurationError** `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

```ts Or null wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const mediaImage = await site.fetchskiMedia().findMediaImage({ id: 'clx8m2k4p0000a1b2c3d4e5f6' }) // MediaImage | null: null when the site answers 404
```

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

```ts tests/unit/fetchski_media_get_media_image.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import GetMediaImageController from '#controllers/get_media_image_controller'

test('fetchskiMedia.getMediaImage', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(GetMediaImageController)
  await controller.handle(ctx)

  site.assertCalled('fetchskiMedia.getMediaImage', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `fetchskiMedia.getMediaImage` with `factories.MediaImage({...})`, the fields you give over a valid example.

```ts tests/unit/fetchski_media_get_media_image_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('fetchskiMedia.getMediaImage answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'fetchskiMedia.getMediaImage': factories.MediaImage({ alt: 'Your value' }),
  })

  const mediaImage = await site.fetchskiMedia().getMediaImage({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(mediaImage, { alt: 'Your value' })
})
```

## Related

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

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

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

> [card] [GET /fetchski-media/images/\{id}](https://docs.fetchski-attract.com/api-reference/fetchski-media/get-one-image.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.