Create an image

use Fetchski\AttractCmsLaravel\Facades\Attract;

$image = Attract::media()->createImage(title: 'Hero banner image', attachment: ['_id' => 'ckj0akbxa003vp39kfbxgb8zg', 'name' => 'blue-box', 'title' => 'blue box', 'extension' => 'png', 'type' => 'attachment', 'group' => 'images', 'length' => 10497, 'md5' => '630eeaaecd0bdc07c4a82eeca4c07588', 'docIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'archivedDocIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'createdAt' => '2026-01-01T00:00:00.000Z']);

{
  "_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"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$image = Attract::media()->createImage(title: 'Hero banner image', attachment: ['_id' => 'ckj0akbxa003vp39kfbxgb8zg', 'name' => 'blue-box', 'title' => 'blue box', 'extension' => 'png', 'type' => 'attachment', 'group' => 'images', 'length' => 10497, 'md5' => '630eeaaecd0bdc07c4a82eeca4c07588', 'docIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'archivedDocIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'createdAt' => '2026-01-01T00:00:00.000Z']);

{
  "_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 createImage() and returns the answer.

Add the controller

app/Http/Controllers/CreateImageController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class CreateImageController
{
    public function __invoke(): Image
    {
        return Attract::media()->createImage(title: 'Hero banner image', attachment: ['_id' => 'ckj0akbxa003vp39kfbxgb8zg', 'name' => 'blue-box', 'title' => 'blue box', 'extension' => 'png', 'type' => 'attachment', 'group' => 'images', 'length' => 10497, 'md5' => '630eeaaecd0bdc07c4a82eeca4c07588', 'docIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'archivedDocIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'createdAt' => '2026-01-01T00:00:00.000Z']);
    }
}

The other values are the example’s: take yours from the request, a form or your database.

Add the route

routes/web.php

use App\Http\Controllers\CreateImageController;
use Illuminate\Support\Facades\Route;

Route::post('/image', CreateImageController::class)->middleware('auth');

It acts with your key’s access, so auth lets only your signed-in users reach it.

Call it

Your own page’s form or script sends POST /image (a form adds @csrf, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

To keep the call in an Action instead, this writes app/Actions/Attract/CreateImage.php (an invokable Action that calls createImage()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action media.createImage

Call it from the terminal

Terminal

php artisan attract:call media.createImage \
  'title=Hero banner image' \
  'attachment={"_id":"ckj0akbxa003vp39kfbxgb8zg","name":"blue-box","title":"blue box","extension":"png","type":"attachment","group":"images","length":10497,"md5":"630eeaaecd0bdc07c4a82eeca4c07588","docIds":["clx8m2k4p0000a1b2c3d4e5f6"],"archivedDocIds":["clx8m2k4p0000a1b2c3d4e5f6"],"createdAt":"2026-01-01T00:00:00.000Z"}'

It calls createImage() on your default site and prints its answer as JSON. It writes, so it asks first: add --force to skip the question in a script. See Call any method from the terminal for every argument type.

Required parameters

Named arguments, e.g. createImage(title: …); leave out the optional ones.

string

required

Required. Image title/alt text.

Attachment|array<string, mixed>

required

Required. File attachment information from upload endpoint.

Show Attachment (Fetchski\AttractCmsLaravel\Data\Attachment)

string

required

Required. Unique attachment identifier.

string

required

Required. Slugified filename.

string

required

Required. Sortified filename.

string

required

Required. File extension.

string

required

Required. Always attachment.

string

required

Required. File group type.

int

required

Required. File size in bytes.

string

required

Required. MD5 checksum.

Collection<int, string>

required

Required. IDs of documents using this attachment.

Collection<int, string>

required

Required. IDs of archived documents using this attachment.

CarbonImmutable

required

Required. When it was uploaded (ISO 8601). Format: an ISO 8601 date and time.

?string

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

array<string, string>|null

An image’s URLs by size (original, max, full, two-thirds, one-half, one-third, one-sixth); unset for other files.

?int

Image width in pixels (images only)

?int

Image height in pixels (images only)

?bool

Whether image is landscape orientation (images only)

?bool

Whether image is portrait orientation (images only)

?CarbonImmutable

When it last changed (ISO 8601). Format: an ISO 8601 date and time.

?bool

Whether the image can be cropped.

array<string, mixed>|null

The crop applied, if any (top, left, width, height).

?bool

Whether any document uses the file.

?string

The media folder holding the file, by its aposDocId.

?string

That folder’s path, e.g. events/summer.

Optional parameters

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.

?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).

?string

Optional. Its URL name: lowercase words joined by hyphens. Left out, it’s made from the title.

?bool

Optional. Leave it out and the site uses false. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.

Enums\Visibility|string|null

Optional. Leave it out and the site uses "public". Who may see it on the site: public (everyone) or loginRequired (signed-in people only). One of public, loginRequired.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Image credit or attribution.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The _id of the piece/page that was copied to create this document (only present if created via _copyingId)

?string

Optional. Leave it out and the site uses "". Image description used for accessibility.

array<int, array<string, mixed>>|Collection<int, array<string, mixed>>|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Its tags, as documents.

?string

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. When set, a URL; empty or null when not.

array<int, array<string, mixed>>|Collection<int, array<string, mixed>>|null

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The media folder holding it (one at most; empty at the library’s root).

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 …).

string

Always sent. Unique identifier.

string

Always sent. Image title/alt text.

string

Always sent. Its URL name: lowercase words joined by hyphens.

string

Always sent.

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

Always sent. An Attachment. File attachment information from upload endpoint.

Show Attachment (Fetchski\AttractCmsLaravel\Data\Attachment)

string

Always sent. Unique attachment identifier.

string

Always sent. Slugified filename.

string

Always sent. Sortified filename.

string

Always sent. File extension.

string

Always sent. Always attachment.

string

Always sent. File group type.

int

Always sent. File size in bytes.

string

Always sent. MD5 checksum.

Collection<int, string>

Always sent. IDs of documents using this attachment.

Collection<int, string>

Always sent. IDs of archived documents using this attachment.

CarbonImmutable

Always sent. When it was uploaded (ISO 8601). Format: an ISO 8601 date and time.

?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).

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.

?int

Sometimes sent: null when the site leaves it out. Image width in pixels (images only)

?int

Sometimes sent: null when the site leaves it out. Image height in pixels (images only)

?bool

Sometimes sent: null when the site leaves it out. Whether image is landscape orientation (images only)

?bool

Sometimes sent: null when the site leaves it out. Whether image is portrait orientation (images only)

?CarbonImmutable

Sometimes sent: null when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.

?bool

Sometimes sent: null when the site leaves it out. Whether the image can be cropped.

array<string, mixed>|null

Sometimes sent: null when the site leaves it out. The crop applied, if any (top, left, width, height).

?bool

Sometimes sent: null when the site leaves it out. Whether any document uses the file.

?string

Sometimes sent: null when the site leaves it out. The media folder holding the file, by its aposDocId.

?string

Sometimes sent: null when the site leaves it out. That folder’s path, e.g. events/summer.

CarbonImmutable

Always sent. Format: an ISO 8601 date and time.

CarbonImmutable

Always sent. Format: an ISO 8601 date and time.

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

?string

Sometimes sent: null when the site leaves it out. Image credit or attribution.

?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)

?string

Sometimes sent: null when the site leaves it out. Image description used for accessibility.

Collection<int, array<string, mixed>>|null

Sometimes sent: null when the site leaves it out. Its tags, as documents.

?string

Sometimes sent: null when the site leaves it out. When set, a URL; empty or null when not.

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

?string

Sometimes sent: null when the site leaves it out.

?string

Sometimes sent: null when the site leaves it out.

?int

Sometimes sent: null when the site leaves it out.

?string

Sometimes sent: null when the site leaves it out.

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.

Errors

Nothing to catch: the SDK retries what is safe, and Laravel logs and renders the rest (see Errors and testing).

400

The site refused what was sent: errors() lists each field’s problem, siteMessage() the first.Retried first: No. Read: errors() (field → messages), siteMessage().

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().

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().

500

The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage(), errorName(), data().

no answer

No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (neverConnected()); never after a timeout, when it may have landed. 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

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.

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:write (or a master above it: content:images:all, content:all, admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403.
Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with Retry-After. The client waits and retries for you; you see RateLimited only if that runs out.
Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
Timeout: 15 s per attempt by default; raise timeout in config/fetchski-attract.php for longer.

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/CreateImageTest.php, then run your tests:

tests/Feature/CreateImageTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class CreateImageTest extends TestCase
{
    use RefreshDatabase;

    public function test_create_image(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/image')
            ->assertOk();

        Attract::assertCalled('media.createImage');
    }
}

Terminal

php artisan test

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

tests/Feature/CreateImageAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

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

        $image = Attract::media()->createImage(title: 'Hero banner image', attachment: ['_id' => 'ckj0akbxa003vp39kfbxgb8zg', 'name' => 'blue-box', 'title' => 'blue box', 'extension' => 'png', 'type' => 'attachment', 'group' => 'images', 'length' => 10497, 'md5' => '630eeaaecd0bdc07c4a82eeca4c07588', 'docIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'archivedDocIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'createdAt' => '2026-01-01T00:00:00.000Z']);

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

List images

Attract::media()->listImages()

Archive images

Attract::media()->archiveImages()

Crop images to a widget’s aspect ratio

Attract::media()->autocropImages()

Copy images to another locale

Attract::media()->localizeImages()

Publish images

Attract::media()->publishImages()

Restore images

Attract::media()->restoreImages()

POST /@apostrophecms/image

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$image = Attract::media()->createImage(title: 'Hero banner image', attachment: ['_id' => 'ckj0akbxa003vp39kfbxgb8zg', 'name' => 'blue-box', 'title' => 'blue box', 'extension' => 'png', 'type' => 'attachment', 'group' => 'images', 'length' => 10497, 'md5' => '630eeaaecd0bdc07c4a82eeca4c07588', 'docIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'archivedDocIds' => ['clx8m2k4p0000a1b2c3d4e5f6'], 'createdAt' => '2026-01-01T00:00:00.000Z']);

{
  "_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"
}

Get started

Using the SDK

Going further

Pages & Site

Content

Media

Forms

Ads & Conversions

Analytics

In your app

Call it from the terminal

Behavior

Test it

List images

Archive images

Crop images to a widget’s aspect ratio

Copy images to another locale

Publish images

Restore images

POST /@apostrophecms/image

In your app

Call it from the terminal

Behavior

Test it

Related

List images

Archive images

Crop images to a widget’s aspect ratio

Copy images to another locale

Publish images

Restore images

POST /@apostrophecms/image