> For the complete documentation index, see [llms.txt](https://docs.axid.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.axid.app/api/reference.md).

# API Reference

The full interactive reference is hosted as a GitBook OpenAPI page. The OpenAPI 3.1 spec is generated from the same Zod schemas the server uses, so what you see is what the server enforces.

## Base URL

```
https://axid.app/api/v1
```

## Authentication

```
Authorization: Bearer axid_live_<your_key>
```

See [Authentication](/guides/authentication.md).

## Feature level

Every response carries `X-Axid-Feature-Level: 5`. See [Core Concepts → feature levels](/guides/concepts.md) for what changes when this header increments.

## 11 stable blocks

These are the only block types accepted from bot tokens. Other registered blocks (e.g. `block_chart`, `block_form`) reject with `400 deprecated_block`.

| Block type                | Purpose                           | Notes                                                  |
| ------------------------- | --------------------------------- | ------------------------------------------------------ |
| `block_text`              | Body paragraph                    | `variant: body \| caption \| overline`                 |
| `block_heading`           | Section heading                   | `level: '1' \| '2' \| '3'`                             |
| `block_quote`             | Quoted excerpt                    | Optional attribution                                   |
| `block_divider`           | Visual separator                  | Optional centered label                                |
| `block_image`             | Image with optional caption       | `url` must be `https:`                                 |
| `block_link_unfurl`       | Link preview card                 | `url` + `title` minimum                                |
| `block_callout`           | Inline callout box                | `variant: info \| warning \| success \| error \| note` |
| `block_alert_banner`      | Severity banner with optional CTA | `variant: info \| warning \| error \| success`         |
| `block_button_group`      | Row of buttons                    | Each button: exactly one of `url` or `actionId`        |
| `block_linear_issue_card` | Linear issue summary              | `url` host must be `linear.app`                        |
| `block_github_pr_card`    | GitHub PR summary                 | `url` host must be `github.com`                        |

## Source

* **OpenAPI spec**: `https://axid.app/api/openapi` (yaml)
* **Repo source**: [`docs/api/openapi.yaml`](https://github.com/axid-app/axid/blob/main/docs/api/openapi.yaml)
* **Block schemas**: `packages/blocks/src/blocks/*/schema.ts` (Zod, SSoT)

***

> **For the interactive reference (with playground)**: see the OpenAPI page in the sidebar.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.axid.app/api/reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.