> ## 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 Markdown template

> The Markdown authoring template: every front-matter field, with this site’s blog categories.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const blogTemplate = await site.blogPosts().getBlogMarkdownTemplate()
await blogTemplate.saveTo(app.makePath('content/blog/')) // …/content/blog/template_blog_post.md
```

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

## In your app

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

**1. Add the controller**

```ts app/controllers/get_blog_markdown_template_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class GetBlogMarkdownTemplateController {
  constructor(protected site: SiteClient) {}

  async handle({ response }: HttpContext) {
    const blogTemplate = await this.site.blogPosts().getBlogMarkdownTemplate()
    response.header('Content-Type', 'text/markdown; charset=utf-8')
    response.header('Content-Disposition', `attachment; filename="${blogTemplate.filename}"`)
    return blogTemplate.content
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const GetBlogMarkdownTemplateController = () => import('#controllers/get_blog_markdown_template_controller')

router.get('/blog/markdown-template', [GetBlogMarkdownTemplateController])
```

**3. Call it**

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

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

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

> [accordion] Returns
>
> A `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.md`; Node, Bun or Deno).
>
> **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 throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see [Map SDK errors to responses](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **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`
>
> `sites.forSite('acme')` named a slug `config/attract.ts` doesn’t list (with the keys in the database: no row in `attract_api_keys`).
>
> **Retried first:** No: nothing was sent. **Read:** `message`, `slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s entry is wrong: a malformed `baseUrl` or key, a key filed under another slug, or no default site. `node ace attract:check` names the fix.
>
> **Retried first:** No: nothing was sent. **Read:** `message` (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` (milliseconds) in `config/attract.ts` for longer.

## Test it

It calls the controller above with the SDK faked: `fakeAttract()` puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as `tests/unit/blog_posts_get_blog_markdown_template.spec.ts`, then run your tests:

```ts tests/unit/blog_posts_get_blog_markdown_template.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import GetBlogMarkdownTemplateController from '#controllers/get_blog_markdown_template_controller'

test('blogPosts.getBlogMarkdownTemplate', async ({ assert }) => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  const controller = await app.container.make(GetBlogMarkdownTemplateController)
  await controller.handle(ctx)

  site.assertCalled('blogPosts.getBlogMarkdownTemplate')
  assert.include(String(ctx.response.getHeader('content-disposition')), 'template_blog_post.md')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `blogPosts.getBlogMarkdownTemplate` with `factories.BlogTemplate({...})`, the fields you give over a valid example.

```ts tests/unit/blog_posts_get_blog_markdown_template_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('blogPosts.getBlogMarkdownTemplate answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'blogPosts.getBlogMarkdownTemplate': factories.BlogTemplate({ filename: 'Your value' }),
  })

  const blogTemplate = await site.blogPosts().getBlogMarkdownTemplate()
  assert.containSubset(blogTemplate, { filename: 'Your value' })
})
```

## Related

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

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

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

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

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

> [card] [Replace a blog post](https://docs.fetchski-attract.com/adonisjs/reference/blog-posts/replace-blog.md)
>
> `site.blogPosts().replaceBlog()`

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