---
title: Prompt block
description: W4b fixture — labeled copyable agent-prompt container (author-shaped).
---

## Overview

This guide exercises the closed-dialect `:::prompt` agent-prompt block end-to-end.

**Document an endpoint**

````
Write reference docs for the POST /v1/pets endpoint with **exact Markdown**.

- Preserve the quoted phrase "créé déjà".
- Keep the body on multiple lines.

```json
{"message": "line one\\nline two"}
```

Finish with W4B2_PROMPT_BODY_CANARY.
````

```
Untitled prompt body for agents: W4B2_PROMPT_UNTITLED_CANARY.
```

:::prompt{actions="paste"}
Invalid actions stay inert rather than rendering copy chrome: W4B2_PROMPT_INVALID_CANARY.
:::

Shared prose after the prompts remains on every surface: W4B2_PROMPT_SHARED_PROSE.

## Link titles

An [advisory link title](https://example.com "The title survives the render") —
CommonMark has always carried it and the renderer used to drop it (E7).

## Footnotes

Footnotes explain themselves in place[^rate-limits] and still jump.

[^rate-limits]: 100 requests per minute per API key, burst 200.

## Related pages

- [/](../index.md)
- [/guides/blocks-showcase](./blocks-showcase.md)
- [/guides/copy-page-off](./copy-page-off.md)
- [/guides/frame-block](./frame-block.md)
- [/guides/getting-started](./getting-started.md)
- [/guides/no-page-title-toc](./no-page-title-toc.md)
- [/guides/recipe-in-guide](./recipe-in-guide.md)
- [/guides/single-entry-toc](./single-entry-toc.md)
- [/guides/visibility-audience](./visibility-audience.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.