Copy a file tag to another locale

use Fetchski\AttractCmsLaravel\Facades\Attract;

$fileTag = Attract::media()->localizeFileTag(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', toLocale: 'en');

{
  "_id": "clx1234567890abcdef",
  "title": "Marketing Materials",
  "slug": "marketing-materials",
  "type": "@apostrophecms/file-tag",
  "archived": false,
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

use Fetchski\AttractCmsLaravel\Facades\Attract;

$fileTag = Attract::media()->localizeFileTag(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', toLocale: 'en');

{
  "_id": "clx1234567890abcdef",
  "title": "Marketing Materials",
  "slug": "marketing-materials",
  "type": "@apostrophecms/file-tag",
  "archived": false,
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}

In your app

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

Add the controller

app/Http/Controllers/LocalizeFileTagController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class LocalizeFileTagController
{
    public function __invoke(string $id): FileTag
    {
        return Attract::media()->localizeFileTag(id: $id, toLocale: 'en');
    }
}

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\LocalizeFileTagController;
use Illuminate\Support\Facades\Route;

Route::post('/file-tag/{id}/localize', LocalizeFileTagController::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 /file-tag/ckitdo5oq004pu69kr6oxo6fr:en:published/localize (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/LocalizeFileTag.php (an invokable Action that calls localizeFileTag()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action media.localizeFileTag

Call it from the terminal

Terminal

php artisan attract:call media.localizeFileTag id=ckitdo5oq004pu69kr6oxo6fr:en:published toLocale=en

It calls localizeFileTag() 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. Answers that copy. 409 conflict when one exists and update is not true.

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.

Laravel

use Fetchski\AttractCmsLaravel\Facades\Attract;

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

Terminal

php artisan attract:call media.listFileTagsPick fields=title,slug

Pass $row['id'] as id. Drafts: list with aposMode: 'draft' to get the draft’s id (Find an id).

Required parameters

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

string

required

Required. Computed document ID (can optionally include mode and locale, e.g., id:en:published) Matches ^\S+$.

string

required

Required. The locale to copy it into: a configured locale, not the current one.

Optional parameters

?bool

Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Overwrite the copy if one already exists there (default false: 409 conflict instead).

Returns

A FileTag (Fetchski\AttractCmsLaravel\Data\FileTag). Built-in file tag piece type for organizing files. Read its properties ($fileTag->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).

string

Always sent.

string

Always sent. Tag name.

string

Always sent. URL-friendly tag name.

string

Always sent.

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. The _id of the piece/page that was copied to create this document (only present if created via _copyingId)

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

404

Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage(), errorName(), data().

409

A copy already exists in that locale: send update: true to overwrite 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:files:write (or a master above it: content:files: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/LocalizeFileTagTest.php, then run your tests:

tests/Feature/LocalizeFileTagTest.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 LocalizeFileTagTest extends TestCase
{
    use RefreshDatabase;

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

        $this->actingAs(User::factory()->create())
            ->postJson('/file-tag/ckitdo5oq004pu69kr6oxo6fr:en:published/localize')
            ->assertOk();

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

Terminal

php artisan test

Answer with your own values: fake media.localizeFileTag with FileTag::factory()->make([...]), the fields you give over a valid example.

tests/Feature/LocalizeFileTagAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class LocalizeFileTagAnswerTest extends TestCase
{
    public function test_localize_file_tag_answers_your_values(): void
    {
        Attract::fake([
            'media.localizeFileTag' => FileTag::factory()->make(['id' => 'Your value']),
        ]);

        $fileTag = Attract::media()->localizeFileTag(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', toLocale: 'en');

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

List images

Attract::media()->listImages()

Create an image

Attract::media()->createImage()

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

POST /@apostrophecms/file-tag/{_id}/localize

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

use Fetchski\AttractCmsLaravel\Facades\Attract;

$fileTag = Attract::media()->localizeFileTag(id: 'ckitdo5oq004pu69kr6oxo6fr:en:published', toLocale: 'en');

{
  "_id": "clx1234567890abcdef",
  "title": "Marketing Materials",
  "slug": "marketing-materials",
  "type": "@apostrophecms/file-tag",
  "archived": false,
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "copyOfId": "ckhdscx5900054z9k88uqs16w:en:published",
  "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

Find the id

Behavior

Test it

List images

Create an image

Archive images

Crop images to a widget’s aspect ratio

Copy images to another locale

Publish images

POST /@apostrophecms/file-tag/{_id}/localize

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List images

Create an image

Archive images

Crop images to a widget’s aspect ratio

Copy images to another locale

Publish images

POST /@apostrophecms/file-tag/{_id}/localize