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

> Reads one image document.

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

$image = Attract::media()->getImage(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published');
```

```json 200 wrap theme={"dark"}
{
  "_id": "clx1234567890abcdef",
  "title": "Hero banner image",
  "slug": "hero-banner-image",
  "type": "@apostrophecms/image",
  "archived": false,
  "visibility": "public",
  "attachment": {
    "_id": "ckj0akbxa003vp39kfbxgb8zg",
    "_url": "https://example.net/uploads/attachments/ckj0akbxa003vp39kfbxgb8zg-blue-box.png",
    "_urls": {
      "key": "Example value"
    },
    "name": "blue-box",
    "title": "blue box",
    "extension": "png",
    "type": "attachment",
    "group": "images",
    "length": 10497,
    "md5": "630eeaaecd0bdc07c4a82eeca4c07588",
    "width": 600,
    "height": 106,
    "landscape": true,
    "portrait": true,
    "docIds": [
      "clx8m2k4p0000a1b2c3d4e5f6"
    ],
    "archivedDocIds": [
      "clx8m2k4p0000a1b2c3d4e5f6"
    ],
    "createdAt": "2026-10-24T09:30:00.000Z",
    "updatedAt": "2026-10-24T09:30:00.000Z",
    "_isCroppable": true,
    "crop": {},
    "used": true,
    "folderId": "clx8m2k4p0000a1b2c3d4e5f6",
    "folderPath": "Example folder path"
  },
  "credit": "Example credit",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
  "alt": "Example alt",
  "_tags": [
    {}
  ],
  "creditUrl": "https://acme.example/example",
  "_folder": [
    {}
  ],
  "feedId": "clx8m2k4p0000a1b2c3d4e5f6",
  "feedGeneration": "Example feed generation",
  "feedOrder": 1,
  "feedSourceKey": "Example feed source key",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class GetImageController
{
    public function __invoke(string $id): Image
    {
        return Attract::media()->getImage(id: $id);
    }
}
```

**2. Add the route**

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

Route::get('/image/{id}', GetImageController::class);
```

**3. Call it**

```bash Terminal theme={"dark"}
curl http://localhost:8000/image/ckitdo5oq004pu69kr6oxo6fr:en:published
```

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/GetImage.php` (an invokable Action that calls `getImage()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action media.getImage
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call media.getImage id=ckitdo5oq004pu69kr6oxo6fr:en:published
```

It calls `getImage()` 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.

## Find the id

`id` is the document’s `_id`, from a list. Ask the list for only the fields you need: each row is a document’s `id` and those fields.

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

$row = Attract::media()->listImagesPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call media.listImagesPick fields=title,slug
```

Pass `$row['id']` as `id`. Drafts: list with `aposMode: 'draft'` to get the draft’s id ([Find an id](https://docs.fetchski-attract.com/find-an-id.md)).

> [accordion] Required parameters
>
> Named arguments, e.g. `getImage(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **Required.** Computed document ID (can optionally include mode and locale, e.g., id:en:published) Matches `^\S+$`.

> [accordion] Optional parameters
>
> **aposMode** `Enums\\AposMode|string|null`
>
> **Optional.** Leave it out and the site uses `"published"`. `published` (the default) or `draft`. Drafts need a credential that may see them: an API key with the type’s write scope (`content:<type>:write`), or a signed-in editor. The public and a key with only the read scope get 403. One of `draft`, `published`.
>
> **aposLocale** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. `en` (default: the site’s default locale).
>
> **renderAreas** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. true: each area’s widgets come back rendered as HTML (`_rendered`), beside their data.

> [accordion] Returns
>
> An `Image` (`Fetchski\AttractCmsLaravel\Data\Image`). Built-in image/media piece type for managing photos and graphics. Read its properties (`$image->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`, `_tags` → `tags`, `_folder` → `folder` …).
>
> **id** `string`
>
> **Always sent.** Unique identifier.
>
> **title** `string`
>
> **Always sent.** Image title/alt text.
>
> **slug** `string`
>
> **Always sent.** Its URL name: lowercase words joined by hyphens.
>
> **type** `string`
>
> **Always sent.**
>
> **visibility** `Enums\\Visibility|string`
>
> **Always sent.** Who may see it on the site: `public` (everyone) or `loginRequired` (signed-in people only). One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **attachment** `Attachment`
>
> **Always sent.** An `Attachment`. File attachment information from upload endpoint.
>
> **Attachment (Fetchski\AttractCmsLaravel\Data\Attachment)**
>
> **id** `string`
>
> **Always sent.** Unique attachment identifier.
>
> **name** `string`
>
> **Always sent.** Slugified filename.
>
> **title** `string`
>
> **Always sent.** Sortified filename.
>
> **extension** `string`
>
> **Always sent.** File extension.
>
> **type** `string`
>
> **Always sent.** Always `attachment`.
>
> **group** `string`
>
> **Always sent.** File group type.
>
> **length** `int`
>
> **Always sent.** File size in bytes.
>
> **md5** `string`
>
> **Always sent.** MD5 checksum.
>
> **docIds** `Collection\<int, string\>`
>
> **Always sent.** IDs of documents using this attachment.
>
> **archivedDocIds** `Collection\<int, string\>`
>
> **Always sent.** IDs of archived documents using this attachment.
>
> **createdAt** `CarbonImmutable`
>
> **Always sent.** When it was uploaded (ISO 8601). Format: an ISO 8601 date and time.
>
> **url** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The file’s URL: set for a file that is not an image. An image’s URLs are in `_urls`, by size (`original` is the file as uploaded).
>
> **urls** `array\<string, string\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. An image’s URLs by size (`original`, `max`, `full`, `two-thirds`, `one-half`, `one-third`, `one-sixth`); unset for other files.
>
> **width** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Image width in pixels (images only)
>
> **height** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Image height in pixels (images only)
>
> **landscape** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Whether image is landscape orientation (images only)
>
> **portrait** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Whether image is portrait orientation (images only)
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **isCroppable** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Whether the image can be cropped.
>
> **crop** `array\<string, mixed\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The crop applied, if any (`top`, `left`, `width`, `height`).
>
> **used** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Whether any document uses the file.
>
> **folderId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The media folder holding the file, by its `aposDocId`.
>
> **folderPath** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. That folder’s path, e.g. `events/summer`.
>
> **createdAt** `CarbonImmutable`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **updatedAt** `CarbonImmutable`
>
> **Always sent.** Format: an ISO 8601 date and time.
>
> **archived** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. In the archive: kept, but out of every list and off the site until it is restored. `false` (or null) for a live document.
>
> **credit** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Image credit or attribution.
>
> **copyOfId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The `_id` of the piece/page that was copied to create this document (only present if created via `_copyingId`)
>
> **alt** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Image description used for accessibility.
>
> **tags** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Its tags, as documents.
>
> **creditUrl** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. When set, a URL; empty or null when not.
>
> **folder** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The media folder holding it (one at most; empty at the library’s root).
>
> **feedId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **feedGeneration** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **feedOrder** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **feedSourceKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out.
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The draft’s preview share key, while its share link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query. Absent otherwise, and on published documents.

> [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 site refused what was sent: `errors()` lists each field’s problem, `siteMessage()` the first.
>
> **Retried first:** No. **Read:** `errors()` (field → messages), `siteMessage()`.
>
> **AuthenticationFailed** `401`
>
> The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **Forbidden** `403`
>
> The key may not do this: a scope it lacks, or an address outside its allowlist. `siteMessage()` names it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No (only a 502, 503 or 504 is retried). **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 `content:images:read` (or a master above it: `content:images:all`, `content:all`, `admin:all`) reads the published documents; drafts (`aposMode=draft`, or a draft `_id`) need `content:images:write` (or a master above it). A signed-in person may call it as far as their own permissions allow; anyone else gets 404.
* **Rate limit:** the key’s own reads-per-minute limit, set when the key is created (default 600); over it, 429 with `Retry-After`. The client waits and retries for you; you see `RateLimited` only if that runs out.
* **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;

$image = Attract::media()->findImage(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published'); // ?Image: 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/GetImageTest.php`, then run your tests:

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetImageTest extends TestCase
{
    public function test_get_image(): void
    {
        Attract::fake();

        $this->getJson('/image/ckitdo5oq004pu69kr6oxo6fr:en:published')->assertOk();

        Attract::assertCalled('media.getImage', fn (array $args): bool => $args['id'] === 'ckitdo5oq004pu69kr6oxo6fr:en:published');
    }
}
```

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

**Answer with your own values:** fake `media.getImage` with `Image::factory()->make([...])`, the fields you give over a valid example (nested ones too).

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetImageAnswerTest extends TestCase
{
    public function test_get_image_answers_your_values(): void
    {
        Attract::fake([
            'media.getImage' => Image::factory()->make(['attachment' => ['id' => 'Your value']]),
        ]);

        $image = Attract::media()->getImage(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published');

        $this->assertSame('Your value', $image->attachment->id);
    }
}
```

## Related

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

> [card] [Create an image](https://docs.fetchski-attract.com/laravel/reference/media/create-image.md)
>
> `Attract::media()->createImage()`

> [card] [Archive images](https://docs.fetchski-attract.com/laravel/reference/media/archive-images.md)
>
> `Attract::media()->archiveImages()`

> [card] [Crop images to a widget’s aspect ratio](https://docs.fetchski-attract.com/laravel/reference/media/autocrop-images.md)
>
> `Attract::media()->autocropImages()`

> [card] [Copy images to another locale](https://docs.fetchski-attract.com/laravel/reference/media/localize-images.md)
>
> `Attract::media()->localizeImages()`

> [card] [Publish images](https://docs.fetchski-attract.com/laravel/reference/media/publish-images.md)
>
> `Attract::media()->publishImages()`

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