# API reference

Every REST operation by area, with its route, the scope it needs and its command.

The REST operations, grouped by area. Each row gives the route, what it does, the level of scope it needs and the matching command.

These pages are made from the same operation list as the OpenAPI document, the command line and the client, so they name every route the API has and no others.

## Areas

1,957 operations.

- [Accounting](https://rivier.ai/docs/reference/accounting.md): Books, bank lines, bills, expenses, reports, tax packs and e-invoices. 81 operations.
- [AI agents](https://rivier.ai/docs/reference/agents.md): Agents and assistants, what each may do alone, assignments and memory grants. 152 operations.
- [Analytics and discovery](https://rivier.ai/docs/reference/analytics.md): Site analytics, tracked prompts, AI search readiness and watched questions. 70 operations.
- [Bookings and stays](https://rivier.ai/docs/reference/bookings.md): Services, bookings, waiting lists, properties, stays, housekeeping and channels. 206 operations.
- [Campaigns and mail](https://rivier.ai/docs/reference/campaigns.md): Campaigns, flows, schedules, templates and the mail sending API. 70 operations.
- [Compliance](https://rivier.ai/docs/reference/compliance.md): Data requests, legal document versions, breaches, impact assessments, retention and records of processing. 78 operations.
- [Connectors](https://rivier.ai/docs/reference/connectors.md): Connections to outside services, whether each still works, and what agents may use. 47 operations.
- [Customers and contacts](https://rivier.ai/docs/reference/contacts.md): People, companies, segments, forms, reviews, conversations and consent. 134 operations.
- [Content](https://rivier.ai/docs/reference/content.md): Entries, types, releases, the delivery API, members and reader comments. 120 operations.
- [Domains and deliverability](https://rivier.ai/docs/reference/domains.md): Domain claims, DNS records, senders and mail deliverability checks. 43 operations.
- [Files](https://rivier.ai/docs/reference/files.md): Assets, uploads, collections, versions and variants. 62 operations.
- [Forms](https://rivier.ai/docs/reference/forms.md): Send a form submission from your own site. 1 operation.
- [Websites](https://rivier.ai/docs/reference/hosting.md): Sites, pages, templates, data sources, builds, deployments and experiments. 163 operations.
- [Inbox](https://rivier.ai/docs/reference/inbox.md): Mailboxes, threads, drafts, rules, the contact centre and the message log for every channel. 157 operations.
- [Keys, events and webhooks](https://rivier.ai/docs/reference/keys.md): Keys, short-lived tokens, apps, the event stream, webhook endpoints and the test project. 25 operations.
- [Memory](https://rivier.ai/docs/reference/memory.md): What Rivier remembers: items, collections, the graph, and context for a question. 76 operations.
- [Model service](https://rivier.ai/docs/reference/models.md): Completions and embeddings from the models set for this project, the names it can use, and its usage. 4 operations.
- [Search and research](https://rivier.ai/docs/reference/search.md): Web search, cited answers, research runs, watched topics and browser sessions. 33 operations.
- [Shop, invoices and payments](https://rivier.ai/docs/reference/shop.md): Orders, carts, quotes, proposals, invoices, credit notes, refunds and payment accounts. 180 operations.
- [Social](https://rivier.ai/docs/reference/social.md): Channels, posts, the calendar and the publishing queue. 11 operations.
- [Usage and limits](https://rivier.ai/docs/reference/usage.md): Plan, usage, limits, allocations, trial and top-ups. 20 operations.
- [Phone and messaging](https://rivier.ai/docs/reference/voice.md): Numbers, calls, call flows, text messages, WhatsApp and verification. 90 operations.
- [Organisations and projects](https://rivier.ai/docs/reference/workspace.md): Organisations, projects, members, roles, branding and account tokens. 134 operations.