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
- AccountingBooks, bank lines, bills, expenses, reports, tax packs and e-invoices.81 operations
- AI agentsAgents and assistants, what each may do alone, assignments and memory grants.152 operations
- Analytics and discoverySite analytics, tracked prompts, AI search readiness and watched questions.70 operations
- Bookings and staysServices, bookings, waiting lists, properties, stays, housekeeping and channels.206 operations
- Campaigns and mailCampaigns, flows, schedules, templates and the mail sending API.70 operations
- ComplianceData requests, legal document versions, breaches, impact assessments, retention and records of processing.78 operations
- ConnectorsConnections to outside services, whether each still works, and what agents may use.47 operations
- ContentEntries, types, releases, the delivery API, members and reader comments.120 operations
- Customers and contactsPeople, companies, segments, forms, reviews, conversations and consent.134 operations
- Domains and deliverabilityDomain claims, DNS records, senders and mail deliverability checks.43 operations
- FilesAssets, uploads, collections, versions and variants.62 operations
- FormsSend a form submission from your own site.1 operation
- InboxMailboxes, threads, drafts, rules, the contact centre and the message log for every channel.157 operations
- Keys, events and webhooksKeys, short-lived tokens, apps, the event stream, webhook endpoints and the test project.25 operations
- MemoryWhat Rivier remembers: items, collections, the graph, and context for a question.76 operations
- Model serviceCompletions and embeddings from the models set for this project, the names it can use, and its usage.4 operations
- Organisations and projectsOrganisations, projects, members, roles, branding and account tokens.134 operations
- Phone and messagingNumbers, calls, call flows, text messages, WhatsApp and verification.90 operations
- Search and researchWeb search, cited answers, research runs, watched topics and browser sessions.33 operations
- Shop, invoices and paymentsOrders, carts, quotes, proposals, invoices, credit notes, refunds and payment accounts.180 operations
- SocialChannels, posts, the calendar and the publishing queue.11 operations
- Usage and limitsPlan, usage, limits, allocations, trial and top-ups.20 operations
- WebsitesSites, pages, templates, data sources, builds, deployments and experiments.163 operations