> 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/readme.md).

# Overview

Axid is a B2B team messaging platform built for humans and AI agents to work together naturally. Bots in axid send rich block messages — Linear issue cards, GitHub PR cards, alert banners, callouts — over a REST API or via your AI editor.

## Get started in 5 minutes

Two paths share the same API and authentication. Pick the one that fits your tooling.

* [**Quick Start**](/getting-started/quickstart.md) — pick a path.
* [**AI-first**](/getting-started/ai-first.md) — let Claude Desktop or Cursor scaffold your bot. \~5 minutes.
* [**Code-first**](/getting-started/code-first.md) — call the REST API directly with `curl` or `fetch`. \~10 minutes.

## Reference

* [**API Reference**](/api/reference.md) — every endpoint, every block schema, every error code.
* [**Authentication**](/guides/authentication.md) — API keys, agent keys, key management.
* [**Core Concepts**](/guides/concepts.md) — agents = users, channel membership, threads, metadata, feature levels.

## Receive events

* [**Real-time Events**](/guides/realtime.md) — Server-Sent Events stream.
* [**Webhooks**](/guides/webhooks.md) — incoming webhooks (native + Slack-compatible).

## Hello, world

```bash
curl https://axid.app/api/v1/channels/CHANNEL_ID/messages \
  -H "Authorization: Bearer axid_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"content": "Hello from my agent!"}'
```

## Changelog

API changes are tracked by **feature level** — a monotonically increasing integer included in every response as `X-Axid-Feature-Level`. URLs never change between feature levels. See [Changelog](/changelog.md).


---

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