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

# Import a post from Markdown or MDX

> Creates a blog post from a Markdown or MDX document with front matter.

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

$blogImportResult = Attract::blogPosts()->importBlogPost(markdown: '---
title: "Our spring update"
excerpt: "What changed this season."
---

## What’s new

The body, in Markdown.
');
```

```json 200 wrap theme={"dark"}
{
  "_id": "clx8k2m0a0011abcd1234efgh:en:draft",
  "type": "@apostrophecms/blog",
  "title": "Five things we learned this year",
  "slug": "five-things-we-learned-this-year",
  "_url": "https://www.example.com/blog/five-things-we-learned-this-year",
  "published": false
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ImportBlogPostController
{
    public function __invoke(): BlogImportResult
    {
        return Attract::blogPosts()->importBlogPost(markdown: '---
title: "Our spring update"
excerpt: "What changed this season."
---

## What’s new

The body, in Markdown.
');
    }
}
```

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

**2. Add the route**

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

Route::post('/blog/from-markdown', ImportBlogPostController::class)->middleware('auth');
```

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

**3. Call it**

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

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call blogPosts.importBlogPost \
  'markdown=---
title: "Our spring update"
excerpt: "What changed this season."
---

## What’s new

The body, in Markdown.
'
```

It calls `importBlogPost()` 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](https://docs.fetchski-attract.com/call-command.md) for every argument type.

Send JSON, the raw document (`text/markdown`, at most 5 MB by default), or a multipart upload with the file and its images.

Images: `featuredImage` in the front matter and every image in the body may be an `https://` URL (fetched, at most 15 MB by default), a library image’s slug, a filename posted with the file (`image`, up to 10), or `generate: <description>` with `generateImages` (at most 4 per import).

**Media on an API key:** a new image (a URL, a posted file or `generate:`) needs `content:images:write`, a new video `content:videos:write` and `content:videos:publish`; a library slug needs `content:images:read` / `content:videos:read`. The blog scopes don’t cover media, and the refusal names the missing scope.

**Publishing:** `publish=true` publishes only when the caller may (a key needs `content:blog:publish`); otherwise the post is saved as a draft. An MDX import is always a draft.

**Removing an import:** delete the post by the draft `_id` the import answered. On an API key that needs `content:blog:delete`.

> [accordion] Required parameters
>
> Named arguments, e.g. `importBlogPost(markdown: …)`; leave out the optional ones.
>
> **markdown** `string` *required*
>
> **Required.** The whole document: YAML front matter between `---` lines, then the Markdown body. `title` is the one required front matter key; `slug`, `publishedAt`, `authorName` (or `authorEmail`), `category`, `excerpt`, `featuredImage` (+ `featuredImageAlt`), `seoTitle`, `seoDescription` and `splitDepth` are optional (the Markdown template, `getBlogMarkdownTemplate`, names every key). Body headings start at `##`: the title is the post’s only `<h1>`.

> [accordion] Optional parameters
>
> **format** `Enums\\Format|string|null`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. Read a raw or JSON body as `mdx`. One of `md`, `mdx`.
>
> **publish** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The same as the body’s `publish`.
>
> **generateImages** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The same as the body’s `generateImages`.
>
> **ai** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. The same as the body’s `_ai`.

> [accordion] Returns
>
> A `BlogImportResult` (`Fetchski\AttractCmsLaravel\Data\BlogImportResult`). The new post. Read its properties (`$blogImportResult->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`, `_url` → `url`).
>
> **id** `string`
>
> **Always sent.**
>
> **type** `string`
>
> **Always sent.**
>
> **title** `string`
>
> **Always sent.**
>
> **slug** `string`
>
> **Always sent.**
>
> **published** `bool`
>
> **Always sent.** False when it was saved as a draft.
>
> **url** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The post’s page.

> [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; the message says which part and how to fix it.
>
> **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 (the message names it) or is used from outside its allowlist; or, on a route that answers 403 to everyone it refuses, the caller may not use it.
>
> **Retried first:** No. **Read:** `siteMessage()`, `errorName()`, `data()`.
>
> **SiteRequestFailed** `413`
>
> The document or a file is over its size limit (the message names it).
>
> **Retried first:** No. **Read:** `reason()`, `status()`.
>
> **RateLimited** `429`
>
> The key used up its 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:** No: a write may have landed. **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:** Only when nothing reached the site (`neverConnected()`); never after a timeout, when it may have landed. **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:blog:write`, or `content:blog:all`, or `content:all`, or `admin:all`, or a signed-in user holding the `blog:import-markdown` permission. Other callers get 403.
* **Rate limit:** the key’s own writes-per-minute limit, set when the key is created (default 120), and 30 imports and validations a minute per caller: whichever runs out first answers 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:** the SDK gives this call 615 s on its own (your client’s own timeout when that is 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/ImportBlogPostTest.php`, then run your tests:

```php tests/Feature/ImportBlogPostTest.php theme={"dark"}
<?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 ImportBlogPostTest extends TestCase
{
    use RefreshDatabase;

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

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

        Attract::assertCalled('blogPosts.importBlogPost');
    }
}
```

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

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ImportBlogPostAnswerTest extends TestCase
{
    public function test_import_blog_post_answers_your_values(): void
    {
        Attract::fake([
            'blogPosts.importBlogPost' => BlogImportResult::factory()->make(['id' => 'Your value']),
        ]);

        $blogImportResult = Attract::blogPosts()->importBlogPost(markdown: '---
title: "Our spring update"
excerpt: "What changed this season."
---

## What’s new

The body, in Markdown.
');

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

## Related

> [card] [List a blog post’s locales](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog-locales.md)
>
> `Attract::blogPosts()->getBlogLocales()`

> [card] [Get the Markdown template](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog-markdown-template.md)
>
> `Attract::blogPosts()->getBlogMarkdownTemplate()`

> [card] [Get the MDX template](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog-mdx-template.md)
>
> `Attract::blogPosts()->getBlogMdxTemplate()`

> [card] [List blog posts](https://docs.fetchski-attract.com/laravel/reference/blog-posts/list-blogs.md)
>
> `Attract::blogPosts()->listBlogs()`

> [card] [Create a blog post](https://docs.fetchski-attract.com/laravel/reference/blog-posts/create-blog.md)
>
> `Attract::blogPosts()->createBlog()`

> [card] [Get a blog post](https://docs.fetchski-attract.com/laravel/reference/blog-posts/get-blog.md)
>
> `Attract::blogPosts()->getBlog()`

> [card] [POST /@apostrophecms/blog/from-markdown](https://docs.fetchski-attract.com/api-reference/blog-posts/import-a-post-from-markdown-or-mdx.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.