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

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$mediaImage = Attract::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**

```php app/Http/Controllers/GetMediaImageController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\MediaImage;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class GetMediaImageController
{
    public function __invoke(string $id): MediaImage
    {
        return Attract::fetchskiMedia()->getMediaImage(id: $id);
    }
}
```

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\GetMediaImageController;
use Illuminate\Support\Facades\Route;

Route::get('/fetchski-media/images/{id}', GetMediaImageController::class);
```

**3. Call it**

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

With `php artisan serve` running, it prints its answer as JSON.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/GetMediaImage.php` (an invokable Action that calls `getMediaImage()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action fetchskiMedia.getMediaImage
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call fetchskiMedia.getMediaImage id=clx8m2k4p0000a1b2c3d4e5f6
```

It calls `getMediaImage()` on your default site and prints its answer as JSON. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

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

> [accordion] Errors
>
> Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/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`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (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` in `config/fetchski-attract.php` for longer.

## More examples

```php Or null wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$mediaImage = Attract::fetchskiMedia()->findMediaImage(id: 'clx8m2k4p0000a1b2c3d4e5f6'); // ?MediaImage: null when the site answers 404
```

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/GetMediaImageTest.php`, then run your tests:

```php tests/Feature/GetMediaImageTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetMediaImageTest extends TestCase
{
    public function test_get_media_image(): void
    {
        Attract::fake();

        $this->getJson('/fetchski-media/images/clx8m2k4p0000a1b2c3d4e5f6')->assertOk();

        Attract::assertCalled('fetchskiMedia.getMediaImage', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `fetchskiMedia.getMediaImage` with `MediaImage::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/GetMediaImageAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\MediaImage;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class GetMediaImageAnswerTest extends TestCase
{
    public function test_get_media_image_answers_your_values(): void
    {
        Attract::fake([
            'fetchskiMedia.getMediaImage' => MediaImage::factory()->make(['alt' => 'Your value']),
        ]);

        $mediaImage = Attract::fetchskiMedia()->getMediaImage(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $mediaImage->alt);
    }
}
```

## Related

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

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

> [card] [Get one video](https://docs.fetchski-attract.com/laravel/reference/fetchski-media/get-media-video.md)
>
> `Attract::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.