# Rykloud > Rykloud is the AI front office for small businesses: sites and stores, inbox and customers, payments, files and > cloud environments, with Rykon AI (AI staff) and Rykon Mail (business email) inside one account. AI agents can > sign themselves up, work in a sandbox and hand their person a claim link. ## The AI front office Rykloud is the AI front office for small businesses: it answers every customer and shows the money it made. Pricing for the front office is not published yet. - [The AI front office](https://rykloud.com/front-office): the joined product and everything it does - [Set up from your website](https://rykloud.com/setup): Rykon reads a site in 7 to 20 s (first facts under 1 s, measured in production on five real sites) and builds booking, inbox, AI receptionist knowledge and follow-ups - [The ledger](https://rykloud.com/ledger): what Rykon did and the money attributed to it by rule, each figure linked to its source - [AI Workforce](https://rykloud.com/ai-workforce): hire AI staff (Rykon Voice, Marketer, Inbox assistant) or build your own (AI Company, agents, Mission Control) - [Solutions](https://rykloud.com/solutions): by need and by industry: e-commerce, healthcare practices, law firms, real estate, financial services and insurance, high-ticket home services, then every other business - [Rykon Voice, the AI receptionist](https://rykloud.com/receptionist): answers your calls day and night, books the job, takes messages and puts callers through; try the live demo with an online store, a dental clinic, a law firm or a real estate team - [Inbox and Customers](https://rykloud.com/inbox): calls, texts, email and site chat in one inbox; Rykon replies from the business's facts, on its own inside limits or for a person to send - [Payments](https://rykloud.com/payments): quotes, invoices, deposits, links and plans, paid by card - [Automations](https://rykloud.com/automations): rules in plain words, run as flows with approvals and versions - [Marketing](https://rykloud.com/marketing): review requests, newsletters to consented customers, a monthly report - [For e-commerce](https://rykloud.com/for/ecommerce): what it does for online stores, direct-to-consumer brands, shopify sellers moving over, digital goods - [For healthcare practices](https://rykloud.com/for/healthcare): what it does for medical and dental practices, aesthetics clinics and med spas, physiotherapy, chiropractic, veterinary practices - [For law firms](https://rykloud.com/for/legal): what it does for law firms, solo attorneys, estate planning, family, business and real estate practices - [For real estate](https://rykloud.com/for/real-estate): what it does for real estate agents, brokerages, property managers, letting agents - [For financial services and insurance](https://rykloud.com/for/financial-services): what it does for financial advisers, insurance agents and brokers, mortgage brokers, accountants and bookkeepers - [For high-ticket home services](https://rykloud.com/for/high-ticket-home-services): what it does for hvac, roofing, solar, remodelling, kitchens and baths, pools, windows and siding - [For salons and spas](https://rykloud.com/for/salons-and-spas): what it does for hair salons, barbers, nail and lash studios, day spas, massage - [For auto repair](https://rykloud.com/for/auto-repair): what it does for independent garages, tyre and alignment shops, body shops, mobile mechanics - [For fitness studios](https://rykloud.com/for/fitness): what it does for gyms, yoga and pilates studios, boxing and martial arts, personal trainers - [For education and tutoring](https://rykloud.com/for/education): what it does for tutors, music and language schools, driving instructors, test prep and learning centres - [For hospitality](https://rykloud.com/for/hospitality): what it does for boutique hotels, b&bs, vacation rentals, event and wedding venues - [For professional services](https://rykloud.com/for/professional-services): what it does for accountants, bookkeepers, consultants, agencies, designers, advisers - [For home services](https://rykloud.com/for/home-services): what it does for plumbers, electricians, hvac, cleaners, landscapers, handymen - [For clinics and dentists](https://rykloud.com/for/clinics-and-dentists): what it does for dentists, physiotherapists, chiropractors, optometrists, therapy practices - [For legal and accounting](https://rykloud.com/for/legal-and-accounting): what it does for law firms, solo attorneys, accountants, bookkeepers, tax preparers - [For salons and clinics](https://rykloud.com/for/salons-and-clinics): what it does for salons, barbers, spas, nail and lash studios, massage and physiotherapy clinics ## Start here - [Agent sign-up runbook](https://rykloud.com/agent-signup.md): challenge, proof of work, a mailed code, your key, the claim link - [agent-access.json](https://rykloud.com/.well-known/agent-access.json): the same, for machines - [Agents start page](https://rykloud.com/agents) - [OpenAPI 3.1](https://api.rykloud.com/v1/public/openapi.json) and the [API reference](https://rykloud.com/docs/api) - [The rykloud CLI](https://rykloud.com/help/command-line/install-the-cli): `rykloud agent signup` ## Try without an account - GET https://rykloud.com/api/agents/demo/templates: site templates with live demos - POST https://rykloud.com/api/agents/demo/ask: ask a question about Rykloud - GET https://api.rykloud.com/v1/public/pricing: prices ## Agent routes - POST /v1/agents/challenges: A challenge to solve (sign-up) and a proof of work (sign-up and delegation) (no token) - POST /v1/agents/signups: Sign up: the answer, the proof of work, a mailbox you can read and the terms; a code is mailed (no token) - POST /v1/agents/signups/:signupId/resend: A new code by mail (three at most, a minute apart) (the sign-up secret) - POST /v1/agents/signups/:signupId/verify: The mailed code for your agent, its sandbox organisation, its first key (shown once) and the claim link (the sign-up secret) - POST /v1/agents/delegations: Ask an existing person for a key that acts for them (device code: they approve one screen) (no token) - POST /v1/agents/delegations/token: Poll for the key: authorization_pending, slow_down, access_denied, expired_token, or the key once (no token) - GET /v1/agents/me: Who this key is, who it acts for and what it may do - GET /v1/agents/me/keys: The agent's keys, with use in the last 30 days - POST /v1/agents/me/keys: Another key (never more than this one may do), shown once - POST /v1/agents/me/keys/:keyId/rotate: A new secret; the old one works ten more minutes - POST /v1/agents/me/keys/:keyId/revoke: Revoke one of the agent's keys - POST /v1/agents/me/claim-link: A fresh claim link to give your person (the last one stops working) - GET /v1/agents/me/sites/templates: The site template library (with each template's live demo) - POST /v1/agents/me/sites/previews: Compose a site from a template, never made: an hour's preview link ## CLI sessions - GET /v1/cli/sessions/current: The session making this request and who it is (a person only) - DELETE /v1/cli/sessions/current: Sign out: revoke the session making this request (a person only) - GET /v1/me/cli-sessions: The person's signed-in CLI sessions (a person only) - POST /v1/me/cli-sessions/:sid/revoke: Revoke one of the person's CLI sessions (a person only) ## Organisations, people and invitations - GET /v1/me/organisations: Organisations the person belongs to - GET /v1/organisations/:id: An organisation, its people and invitations - PATCH /v1/organisations/:id: Rename an organisation (owner) - GET /v1/organisations/:id/checklist: What the organisation has set up and the next step, from real state - PUT /v1/organisations/:id/onboarding: What the organisation wants to set up (owner or admin), or hide the checklist - GET /v1/organisations/:id/connections: How the organisation's products are connected to each other: every link, its state, who allowed it and what it allows - PUT /v1/organisations/:id/nudges/:nudge: Dismiss a suggestion to connect two products, for yourself (a person only) - DELETE /v1/organisations/:id/nudges/:nudge: Bring a dismissed suggestion back (a person only) - PUT /v1/organisations/:id/also-products/:product: Add a product made by Rykon outside Rykloud (Swift Paybooks) to the organisation's home and menu, or hide it (owner or admin) - DELETE /v1/organisations/:id/members/:memberId: Remove a person from the organisation (a person only) - POST /v1/organisations/:id/invitations: Invite a person by address (a person only) - DELETE /v1/organisations/:id/invitations/:invitationId: Withdraw an invitation (a person only) - GET /v1/me/invitations: Invitations waiting for the person (a person only) - POST /v1/invitations/:id/accept: Accept an invitation (a person only) - POST /v1/organisations: Create an organisation; you are its owner (a person only) - PATCH /v1/organisations/:id/members/:memberId: Change a person's role (admin, member, billing) (a person only) - POST /v1/organisations/:id/leave: Leave the organisation (never its last owner) (a person only) - POST /v1/organisations/:id/invitations/:invitationId/resend: Send an invitation again, with a new expiry (a person only) - POST /v1/organisations/:id/transfers: Offer ownership to a person in the organisation (owner); it changes when they accept (a person only) - DELETE /v1/organisations/:id/transfers/:transferId: Withdraw an ownership offer (owner) (a person only) - GET /v1/me/transfers: Ownership offers waiting for the person (a person only) - POST /v1/transfers/:id/accept: Accept an ownership offer (a person only) - POST /v1/transfers/:id/decline: Decline an ownership offer (a person only) - GET /v1/organisations/:id/closure: What deleting the organisation would do, and what stands in the way (owner) - POST /v1/organisations/:id/closure: Delete the organisation after the grace period, confirmed by its name (owner) (a person only) - DELETE /v1/organisations/:id/closure: Cancel a deletion during the grace period (owner) (a person only) - GET /v1/me/closed-organisations: Deleted organisations the person owned (their audit record stays exportable) (a person only) - GET /v1/organisations/:id/audit: The organisation's audit record, JSON pages or CSV (owners, and owners at the close) - POST /v1/organisations/:id/product-transfers: Offer one of the organisation's product accounts to a confirmed address (owner) (a person only) - GET /v1/organisations/:id/product-transfers: The organisation's product transfers, both directions (owners and admins) - GET /v1/me/product-transfers: Product transfers offered to the person, and those they made (a person only) - GET /v1/product-transfers/:id: One product transfer (either side's owners and admins, the recipient) (a person only) - POST /v1/product-transfers/:id/accept: Accept a product transfer into an organisation you own, or a new one (a person only) - POST /v1/product-transfers/:id/decline: Decline a product transfer offered to you (a person only) - POST /v1/product-transfers/:id/withdraw: Withdraw a product transfer before it moves (owner of the source) (a person only) - GET /v1/organisations/:id/mail-grants: The organisation's mail grants: Rykon AI's agent inboxes in Rykon Mail - DELETE /v1/organisations/:id/mail-grants/:grantId: Revoke a mail grant (owner or admin); its inboxes are paused (a person only) ## Projects and access - GET /v1/organisations/:id/projects: Projects of an organisation - POST /v1/organisations/:id/projects: Create a project - GET /v1/organisations/:id/projects/:pid: A project and its environments - PATCH /v1/organisations/:id/projects/:pid: Rename or describe a project, or require approval in production - DELETE /v1/organisations/:id/projects/:pid: Delete an empty project - GET /v1/organisations/:id/projects/:pid/access: Who may do what in a project - PUT /v1/organisations/:id/projects/:pid/access/:subject: Give a member a role in a project (a person only) - DELETE /v1/organisations/:id/projects/:pid/access/:subject: Take back a project role (a person only) - POST /v1/organisations/:id/projects/:pid/transfer: Offer a project, with its environments, to another organisation (owner) (a person only) ## Environments - GET /v1/environments/catalogue: Clouds, regions, sizes and products on offer - GET /v1/organisations/:id/environments/options: What this organisation may ask for, with prices - POST /v1/organisations/:id/environments/quote: The price of a size and place before asking - GET /v1/organisations/:id/environments: Environments of an organisation - POST /v1/organisations/:id/environments: Ask for an environment: it is planned and priced, then waits for an owner - GET /v1/organisations/:id/environments/:envId: An environment, its plan, timeline and activity - PATCH /v1/organisations/:id/environments/:envId: Move an environment to another project or stage - POST /v1/organisations/:id/environments/:envId/approve: Approve the plan at its stated price (owner) - POST /v1/organisations/:id/environments/:envId/cancel: Cancel an environment that has not started - POST /v1/organisations/:id/environments/:envId/stop: Stop and keep its data; nothing runs or bills at the cloud - POST /v1/organisations/:id/environments/:envId/restore: Start a stopped environment from its kept data - POST /v1/organisations/:id/environments/:envId/retry: Try a failed step again - POST /v1/organisations/:id/environments/:envId/destroy: Destroy an environment and everything in it (a person only) - POST /v1/organisations/:id/environments/:envId/drift/reconcile: Put back what changed outside Rykloud - POST /v1/organisations/:id/environments/:envId/drift/keep: Keep what changed outside Rykloud - GET /v1/organisations/:id/environments/:envId/versions: What it runs and what it could run - POST /v1/organisations/:id/environments/:envId/update/review: Review an update: planned and priced, then waits for an owner - POST /v1/organisations/:id/environments/:envId/update/approve: Approve an update at its stated price (owner) - POST /v1/organisations/:id/environments/:envId/update/withdraw: Withdraw an update on its way - POST /v1/organisations/:id/environments/:envId/maintenance: Set the maintenance window updates wait for - GET /v1/organisations/:id/environments/:envId/logs: The environment's own workloads' logs - GET /v1/organisations/:id/environments/:envId/access: Who may do what in an environment - PUT /v1/organisations/:id/environments/:envId/access/:subject: Give a member a role in an environment (a person only) - DELETE /v1/organisations/:id/environments/:envId/access/:subject: Take back an environment role (a person only) - POST /v1/organisations/:id/environments/:envId/wake: Wake a stopped environment ## Environment settings: networking, backups, schedules - GET /v1/organisations/:id/environments/:envId/settings: Networking, backups, scaling and schedule - POST /v1/organisations/:id/environments/:envId/settings/preview: Preview a settings change with its price - POST /v1/organisations/:id/environments/:envId/settings/changes/:changeId/apply: Apply a previewed settings change - POST /v1/organisations/:id/environments/:envId/settings/changes/:changeId/withdraw: Withdraw a previewed settings change - POST /v1/organisations/:id/environments/:envId/links: Ask for a private link to another environment - POST /v1/organisations/:id/environments/:envId/links/:linkId/accept: Accept a private link - POST /v1/organisations/:id/environments/:envId/links/:linkId/remove: Remove a private link - POST /v1/organisations/:id/environments/:envId/vpn/keys: Register a WireGuard public key for the person (a person only) - POST /v1/organisations/:id/environments/:envId/vpn/keys/:keyId/revoke: Revoke a WireGuard key (a person only) - POST /v1/organisations/:id/environments/:envId/backups/now: Back up the environment now - POST /v1/organisations/:id/environments/:envId/backups/test: Test a restore of the latest backup now - GET /v1/organisations/:id/environments/:envId/backups/:backupId/restore: What restoring a backup would do - POST /v1/organisations/:id/environments/:envId/backups/:backupId/restore: Restore a backup (owner, typing the name) (a person only) - PUT /v1/organisations/:id/environments/:envId/schedule: Set the scheduled stop and start - DELETE /v1/organisations/:id/environments/:envId/schedule: Remove the scheduled stop and start ## Resources and changes - GET /v1/organisations/:id/environments/:envId/resources: An environment's resources (the canvas) - GET /v1/organisations/:id/environments/:envId/resources/:rid: A resource with its status, settings and backups - GET /v1/organisations/:id/environments/:envId/resources/:rid/logs: A resource's logs - POST /v1/organisations/:id/environments/:envId/resources/:rid/backup: Back up a database now - POST /v1/organisations/:id/environments/:envId/resources/:rid/credentials: Reveal a database's connection details (audited) (a person only) - GET /v1/organisations/:id/environments/:envId/changes: Changes in an environment and their state - POST /v1/organisations/:id/environments/:envId/changes/preview: Preview a resource change with its price - POST /v1/organisations/:id/environments/:envId/changes/:cid/apply: Apply a previewed change at its stated price - POST /v1/organisations/:id/environments/:envId/changes/:cid/approve: Approve a change (owner, or a second maintainer in production) - POST /v1/organisations/:id/environments/:envId/changes/:cid/reject: Reject a change waiting for approval - POST /v1/organisations/:id/environments/:envId/changes/:cid/withdraw: Withdraw a change ## Services: builds and deploys - GET /v1/organisations/:id/environments/:envId/resources/:rid/builds: A service's builds - POST /v1/organisations/:id/environments/:envId/resources/:rid/builds: Build a service from its branch head or a commit - GET /v1/organisations/:id/environments/:envId/resources/:rid/builds/:bid: A build - GET /v1/organisations/:id/environments/:envId/resources/:rid/builds/:bid/logs: A build's log lines after a sequence number - POST /v1/organisations/:id/environments/:envId/resources/:rid/builds/:bid/cancel: Cancel a build - GET /v1/organisations/:id/environments/:envId/resources/:rid/deploys: A service's deploys - POST /v1/organisations/:id/environments/:envId/resources/:rid/deploys/:did/rollback: Preview a rollback to a kept deploy - PATCH /v1/organisations/:id/environments/:envId/resources/:rid/source: Change a service's branch or automatic deploys - POST /v1/organisations/:id/environments/:envId/resources/:rid/restart: Restart a service ## Secret groups and variables - POST /v1/organisations/:id/environments/:envId/resources/:rid/secrets/:name/reveal: Reveal one secret value (audited) (a person only) - GET /v1/organisations/:id/environments/:envId/resources/:rid/variables: A service's variables and where each comes from - POST /v1/organisations/:id/environments/:envId/secrets/import: Preview importing a .env file into a secret group - GET /v1/organisations/:id/projects/:pid/secrets: A project's secret definitions - PUT /v1/organisations/:id/projects/:pid/secrets/:name: Set a project secret definition - DELETE /v1/organisations/:id/projects/:pid/secrets/:name: Delete a project secret definition ## Custom domains - GET /v1/organisations/:id/environments/:envId/domains: An environment's custom domains - POST /v1/organisations/:id/environments/:envId/domains: Add a custom domain to a service; answers the TXT record to create - POST /v1/organisations/:id/environments/:envId/domains/:did/verify: Check a domain's TXT record now - DELETE /v1/organisations/:id/environments/:envId/domains/:did: Remove a custom domain ## Global views - GET /v1/organisations/:id/databases: Databases across projects and environments - GET /v1/organisations/:id/applications: Services across projects and environments - GET /v1/organisations/:id/storage: Buckets across projects and environments - GET /v1/organisations/:id/secrets: Secret groups across projects and environments - GET /v1/organisations/:id/domains: Custom domains across projects and environments - POST /v1/organisations/:id/databases/bulk: Back up several databases - POST /v1/organisations/:id/storage/bulk: Act on several buckets - POST /v1/organisations/:id/secrets/bulk: Act on several secret groups - POST /v1/organisations/:id/domains/bulk: Act on several domains ## Activity and notifications - GET /v1/organisations/:id/activity: The organisation's activity (owners and admins all, members their environments') - GET /v1/me/notifications: The person's notifications (a person only) - POST /v1/me/notifications/read: Mark notifications read (a person only) - GET /v1/organisations/:id/notification-preferences: Notification preferences (a person only) - PUT /v1/organisations/:id/notification-preferences: Set notification preferences (a person only) - GET /v1/status: Rykloud's status and incidents ## Terms of service - GET /v1/me/terms: The current terms of service and whether the person has accepted them (a person only) ## Prices and billing - GET /v1/public/pricing: The public price list - GET /v1/organisations/:id/billing: The organisation's billing: usage, limits, payment standing - PUT /v1/organisations/:id/billing/limits: Set spending limits (owner or billing manager) (a person only) - GET /v1/organisations/:id/environments/:envId/team: An environment's AI team: seats and mailboxes - PUT /v1/organisations/:id/environments/:envId/team: Set an environment's seats and mailboxes, at the stated monthly price (a person only) ## The cloud terminal - GET /v1/organisations/:id/terminal/sessions: Terminal sessions: the person's own, or every one for owners and admins - DELETE /v1/organisations/:id/terminal/sessions/:sid: End a terminal session - GET /v1/organisations/:id/terminal/usage: Cloud shell hours this month, per person - GET /v1/organisations/:id/terminal/settings: The organisation's terminal settings - PUT /v1/organisations/:id/terminal/settings: Set the idle timeout, the longest session and recording (owners and admins) (a person only) - GET /v1/organisations/:id/environments/:envId/terminal/approvals: A production environment's shell approvals - POST /v1/organisations/:id/environments/:envId/terminal/approvals: Ask for production shell access, or break the glass (owners) (a person only) - POST /v1/organisations/:id/environments/:envId/terminal/approvals/:aid/:what: Approve, decline or withdraw a production shell ask (a person only) ## Git connections - GET /v1/organisations/:id/git/sources: Git hosts registered for the organisation - GET /v1/organisations/:id/git/connections: Git connections - GET /v1/organisations/:id/git/connections/:cid/repositories: Repositories a connection can read - GET /v1/organisations/:id/git/connections/:cid/repositories/:owner/:repo/branches: A repository's branches - GET /v1/organisations/:id/git/connections/:cid/branches: A repository's branches, the repository as ?repository= (GitLab paths with groups) ## previews - GET /v1/organisations/:id/projects/:pid/previews/setting: The project's preview setting: host, size, database mode, limits, ceiling - PUT /v1/organisations/:id/projects/:pid/previews/setting: Turn previews on or off and set their limits (an owner states the ceiling) (a person only) - GET /v1/organisations/:id/projects/:pid/previews: The project's previews: pull request, address, database branch, state - POST /v1/organisations/:id/projects/:pid/previews/:prid/tear-down: Tear a preview down now ## Agents and agent keys - GET /v1/organisations/:id/agents: The organisation's agents and their keys: who each acts for, scope, expiry, last use (a person only) - POST /v1/organisations/:id/agents/:agentId/revoke: Revoke an agent and every key it holds (a person only) - POST /v1/organisations/:id/agent-keys/:keyId/revoke: Revoke one agent key (a person only) - PATCH /v1/organisations/:id/agent-keys/:keyId: Shorten a key's expiry, lower its spend cap or set its IP allow-list (a person only) - GET /v1/organisations/:id/agent-keys/:keyId/activity: One key's record: what its requests did, and its use per day (a person only) - GET /v1/me/agent-keys: Agent keys that act for the person, across organisations (a person only) ## Other products - [Rykon AI](https://rykon.ai): AI staff; MCP server at https://mcp.rykon.ai/mcp (a person signs in with the Rykon account) - [Rykon Mail](https://rykonmail.com): business email; API at https://app.rykonmail.com/api/v1