Submit a video for review

use Fetchski\AttractCmsLaravel\Facades\Attract;

$draftSubmission = Attract::videos()->submitVideo(id: 'clx8m2k4p0000a1b2c3d4e5f6');

{
  "by": "Example by",
  "byId": "clx8m2k4p0000a1b2c3d4e5f6",
  "at": "2026-10-24T09:30:00.000Z"
}

In your app

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

Add the controller

app/Http/Controllers/SubmitVideoController.php

<?php

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class SubmitVideoController
{
    public function __invoke(string $id): DraftSubmission
    {
        return Attract::videos()->submitVideo(id: $id);
    }
}

Add the route

routes/web.php

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

Route::post('/video/{id}/submit', SubmitVideoController::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 /video/clx8m2k4p0000a1b2c3d4e5f6/submit (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/SubmitVideo.php (an invokable Action that calls submitVideo()) and its test under tests/Feature/Actions/Attract/ (Pest when your app has it):

Terminal

php artisan make:attract-action videos.submitVideo

Call it from the terminal

Terminal

php artisan attract:call videos.submitVideo id=clx8m2k4p0000a1b2c3d4e5f6

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

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::videos()->listVideosPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null

Terminal

php artisan attract:call videos.listVideosPick 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. submitVideo(id: …); leave out the optional ones.

string

required

Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).

Returns

A DraftSubmission (Fetchski\AttractCmsLaravel\Data\DraftSubmission). Who submitted the draft for review, and when. Read its properties ($draftSubmission->byId): each says whether the site always sends it.

string

Always sent. The submitter’s user _id.

CarbonImmutable

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

?string

Sometimes sent: null when the site leaves it out. The submitter’s name.

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

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:videos:write (or a master above it: content:videos: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/SubmitVideoTest.php, then run your tests:

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

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

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

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

Terminal

php artisan test

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

tests/Feature/SubmitVideoAnswerTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature;

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

final class SubmitVideoAnswerTest extends TestCase
{
    public function test_submit_video_answers_your_values(): void
    {
        Attract::fake([
            'videos.submitVideo' => DraftSubmission::factory()->make(['byId' => 'Your value']),
        ]);

        $draftSubmission = Attract::videos()->submitVideo(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $draftSubmission->byId);
    }
}

List a video’s locales

Attract::videos()->getVideoLocales()

List videos

Attract::videos()->listVideos()

Create a video

Attract::videos()->createVideo()

Get a video

Attract::videos()->getVideo()

Replace a video

Attract::videos()->replaceVideo()

Delete a video

Attract::videos()->deleteVideo()

POST /video/{_id}/submit

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

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 a video’s locales

List videos

Create a video

Get a video

Replace a video

Delete a video

POST /video/{_id}/submit

In your app

Call it from the terminal

Find the id

Behavior

Test it

Related

List a video’s locales

List videos

Create a video

Get a video

Replace a video

Delete a video

POST /video/{_id}/submit