> ## 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 the MDX template

> The MDX authoring template: the Markdown front matter plus the section components an MDX post may use inline, generated from this site’s own widgets.

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

$path = Attract::blogPosts()->getBlogMdxTemplate()->saveTo(storage_path('app/blog/')); // …/storage/app/blog/template_blog_post.mdx
```

```json 200 wrap theme={"dark"}
{
  "filename": "template_blog_post.mdx",
  "content": "---\ntitle: …\n---\n"
}
```

## In your app

A controller answers a route on your app: it calls `getBlogMdxTemplate()` and answers the file as a download (`download()`).

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Http\Response;

final class GetBlogMdxTemplateController
{
    public function __invoke(): Response
    {
        return Attract::blogPosts()->getBlogMdxTemplate()->download();
    }
}
```

**2. Add the route**

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

Route::get('/blog/mdx-template', GetBlogMdxTemplateController::class);
```

Register it before `Route::get('/blog/{id}', …)`: Laravel takes the first route that matches, and that one matches this URL too.

**3. Call it**

```bash Terminal theme={"dark"}
curl -OJ http://localhost:8000/blog/mdx-template
```

With `php artisan serve` running, it saves `template_blog_post.mdx` in the folder you run it from (`-O` saves the answer, `-J` under the name the download gives).

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

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call blogPosts.getBlogMdxTemplate --save=storage/app/blog/
```

It calls `getBlogMdxTemplate()` on your default site and saves the file in `storage/app/blog/` as `template_blog_post.mdx` (leave out `--save` to print it as JSON). See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

> [accordion] Parameters
>
> None: call it with no arguments.

> [accordion] Returns
>
> A `BlogTemplate` (`Fetchski\AttractCmsLaravel\Data\BlogTemplate`). The template. Read its properties (`$blogTemplate->filename`): each says whether the site always sends it. Save it with `saveTo($path)` (a folder keeps the site’s file name, `template_blog_post.mdx`), or answer a browser with `download()`.
>
> **filename** `string`
>
> **Always sent.** The file name to save the template under.
>
> **content** `string`
>
> **Always sent.** The template: front matter naming every field, then guidance for the body.

> [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)).
>
> **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()`.
>
> **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:** A 502, 503 or 504: yes, after 0.5 s then 1 s. A 500: no. **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: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 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.

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetBlogMdxTemplateTest extends TestCase
{
    public function test_get_blog_mdx_template(): void
    {
        Attract::fake();

        $this->getJson('/blog/mdx-template')->assertDownload('template_blog_post.md');

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

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

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class GetBlogMdxTemplateAnswerTest extends TestCase
{
    public function test_get_blog_mdx_template_answers_your_values(): void
    {
        Attract::fake([
            'blogPosts.getBlogMdxTemplate' => BlogTemplate::factory()->make(['filename' => 'Your value']),
        ]);

        $blogTemplate = Attract::blogPosts()->getBlogMdxTemplate();

        $this->assertSame('Your value', $blogTemplate->filename);
    }
}
```

## 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] [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] [Replace a blog post](https://docs.fetchski-attract.com/laravel/reference/blog-posts/replace-blog.md)
>
> `Attract::blogPosts()->replaceBlog()`

> [card] [GET /@apostrophecms/blog/mdx-template](https://docs.fetchski-attract.com/api-reference/blog-posts/get-the-mdx-template.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.