Documentation
Harakumo docs
One API key, your whole cloud. Every service over plain HTTPS; most also through the SDK, the CLI or an AI assistant.
New to Harakumo? Read these first.
- Quickstart: your first appFrom signup to a live app with a database, browser uploads and a payment link, on the free plan.Build your first app
- Build standardWhat an app built on Harakumo includes by default: tab icons, every screen size, legal pages, sign-in and an admin dashboard.See the standard
- Getting startedWorkspaces, projects and resources, installing the SDK and the CLI, and your first API call.Learn the basics
- AI connector (MCP)Connect Claude, ChatGPT or any MCP client and run the platform from a conversation.Connect your AI
How it fits
One key, every service
Everything you create lives in a project, projects live in a workspace, and the workspace holds the plan, the Balance and the team.
Every service has a REST API over plain HTTPS (https://harakumo.com/api/…), and most are also in the dashboard, the JavaScript SDK and the CLI: each topic's Reference says which. An AI assistant connected over MCP uses the same API, with your permissions.
The whole platform, one page per topic
32 guides, one page each. Every service's page ends with its SDK and REST reference (and the CLI, where it has one) and says plainly what it does not do yet.
Start here 10 topics
- Getting startedHarakumo is one account and one API key for hosting, databases, storage, auth, payments, email, domains and AI — reachable from the SDK, the CLI, plain HTTPS or an AI assistant.
- Quickstart: your first appFrom signup to a live app with a database, browser uploads to storage and a payment link, on the free Hobby plan, with code that runs as written: one worker.js file, no server to run.
- Build standardWhat a finished app built on Harakumo includes, for the AI assistant building it: tab icons, every screen size, pagination, legal pages, complete sign-in, an admin dashboard and the engineering basics — by default, without being asked.
- Mobile build standardWhat a finished iPhone and Android app built on Harakumo includes, for the AI assistant building it: the Expo stack, every screen state, sign-in that lasts, offline, push, store pages and the review rules — by default, without being asked.
- API keys & authenticationEvery call carries a Bearer credential.
- Limits & scalingEvery plan number and technical limit in one place, what happens at each one, and how each service behaves as an app grows to millions of users.
- Errors & rate limitsEvery error is JSON with an
errorsentence you can show a person, and often acodea program can branch on. - ArchitectureHow the pieces fit: your app on the edge, and every capability it needs — data, files, search, sessions, sign-in, checkout, email, AI — one call away on the same key.
- Use Harakumo from a phone appHow an iOS or Android app uses Harakumo as its backend: sign-in with the publishable client id, a function as the app's API, files, payments, push, and the website the stores ask for.
- What Harakumo keeps about your app's usersWhat Harakumo stores about the people who use your app, service by service: what each record holds, how long it is kept and who else receives it.
Build & deploy 4 topics
- Projects & environmentA project is one app: its address, environment variables and every resource it uses.
- DeploymentsDeploy from GitHub, a folder upload or Harakumo Repos.
- FunctionsOne JavaScript module that answers HTTP requests at its own edge URL, https://hk-<project>--<function>.harakumo.app.
- ReposHarakumo's own code store: every push is a numbered, immutable commit, and any commit deploys to any project.
Data 4 topics
- DatabasesEdge SQLite databases queried over HTTPS with an API key: single statements, batches of up to 100, and .sql export.
- StoragePrivate object storage with no egress fees.
- Vector DBEmbedding collections for semantic search and RAG.
- MemoryThree kinds of memory for AI apps — key-value with TTL, conversation transcripts, and semantic recall by meaning — each partitioned per end user with a scope.
AI 3 topics
- AI GatewayOne endpoint and one key for Claude, GPT, Gemini, Grok, Kimi and Llama: chat with history and streaming, an OpenAI-compatible URL, embeddings, and exact cost on every answer.
- AgentsA model with standing instructions and a chosen set of Harakumo tools, run when asked, on a schedule, on a signed event from your app or from a visitor's chat.
- MediaVideo upload with HLS playback, and live channels with an RTMP ingest URL and HLS output.
App services 3 topics
- Auth poolsSign-in for your app's users: email and password, Sign in with Apple and Google, email verification and password reset by code, JWTs you verify yourself, refresh tokens that keep people signed in for months, and the account actions both app stores require (change password or email, delete the account).
- PaymentsTake card payments without opening a processor account.
- MailTransactional email in one API call, from your own domain or no-reply@harakumo.com, under your app's name, with a send log, a suppression list and per-plan quotas.
Web 3 topics
- DomainsBuy domains inside Harakumo, paid from the Balance, connect domains you own by nameservers, edit DNS, auto-renew from the Balance, and transfer in or out.
- ShieldCountry rules for static sites, server apps, functions and worker.js programs, address lists and AI-crawler blocking for static sites and functions, password-protected static sites, counts of what the rules caught, and your workspace's security checks.
- CDNHow long the edge keeps a static site's pages and files, and browsers its files.
Account & billing 5 topics
- Workspaces, roles & teamsThe account → workspace → project → resource hierarchy, the four roles, invitations and seat limits, and what deleting a workspace or account does.
- Security & data isolationTwo-factor sign-in, scoped API keys, read-only AI connectors, and how one customer's data is kept apart from another's at every layer.
- Billing, Balance & AI creditsOne plan covers several of your workspaces (Pro 3, Team 10 and Scale 25) and includes an amount of file storage, database storage and build minutes, shared across them.
- Usage, activity & audit logWhat your workspace used, measured per project and per day; what needs attention; and an audit trail of every change to your setup.
- AI connector (MCP)Connect Claude, ChatGPT or any MCP client to https://harakumo.com/mcp and run the platform from a conversation, read-only or with permission to make changes.
Docs your AI reads for itself
Every topic is also plain Markdown, from the same source as these pages, so an assistant works from the current docs, not a pasted copy.
Copy the full docs
All 32 topics as one Markdown file, ready to paste into any assistant.
llms.txt
The index an AI looks for, at
/llms.txt: every service, the plans, and a link to each topic as Markdown.get_docs in the AI connector
A connected assistant calls
get_docswith a topic and reads the live guide, instead of working from memory.In your terminal
Install the CLI and run
harakumo docsto read these docs without leaving the shell.
Need a key?
Owners and admins create one in Settings → API access. The free plan needs no card.