# Kilby > Kilby is a platform for running web services, private services, background workers, cron jobs and managed Postgres (with pgvector) from container images, built for AI products. Everything below works over a REST API with an OpenAPI description, so an agent can deploy and operate it. These pages are plain Markdown. Start with "Use Kilby from an AI agent" if you are an agent. Every page is also Markdown at /docs/.md, and the whole documentation is one file at /llms-full.txt. ## Get started - [Kilby documentation](https://onkilby.com/docs/overview.md): What Kilby runs, how to start, and where each answer is. - [Quickstart](https://onkilby.com/docs/quickstart.md): Create an account and run a public container image at an HTTPS address in about two minutes. - [Templates](https://onkilby.com/docs/templates.md): Deploy a ready-made open-source AI app, vector database or tool from the dashboard, the CLI, the API or a Deploy to Kilby button. - [Use Kilby from an AI agent](https://onkilby.com/docs/agents.md): How an AI agent deploys and operates Kilby: the REST API and OpenAPI, the MCP server, which key to use, the safety model, and a worked example. ## Build and run - [Services](https://onkilby.com/docs/services.md): Web services, private services, workers and cron jobs: ports, health checks, start commands and instance types with list prices. - [Deploy from Git](https://onkilby.com/docs/deploy-from-git.md): Build a service from a Git repository instead of an image: public repositories by their address, private ones through GitHub, how new commits reach the service, and what happens when a host says slow down. - [Pull request previews](https://onkilby.com/docs/previews.md): A preview of every pull request, at an address of its own, built on every new commit and removed when the pull request is closed or merged. What a preview copies from the service, and what it never does. - [Environment variables and secrets](https://onkilby.com/docs/environment.md): Set variables and secret files for a service, generate random values, how they are stored, who can read them, and the limits. - [Environment groups](https://onkilby.com/docs/environment-groups.md): Define variables once and link them to many services: the precedence rule, what a change restarts, and how to manage groups in the dashboard, the CLI and the API. - [Projects and environments](https://onkilby.com/docs/projects.md): Group the services, cron jobs and databases of a workspace into projects with environments such as Production and Staging. This organizes; it isolates nothing. - [Deploys, rollbacks and downtime](https://onkilby.com/docs/deploys.md): What starts a deploy, how a rolling deploy avoids downtime, why a service with a disk cannot, why a deploy fails, and how to roll back. - [Custom domains](https://onkilby.com/docs/domains.md): Serve a web service on your own domain with a certificate Kilby issues and renews: DNS records, timing and every message. - [DNS AI](https://onkilby.com/docs/dns-ai.md): Host your domain's DNS on Kilby. Before the move, Kilby captures the records your domain answers today and checks each one in real DNS, so the site and the email keep working. Then point services at Kilby in one click. - [AI Gateway](https://onkilby.com/docs/ai-gateway.md): Call AI models from your apps through one OpenAI-compatible endpoint, with a key per app, limits per key, a monthly cap and metered usage. Kilby's router picks the model for each prompt. - [Neuravision](https://onkilby.com/docs/neuravision.md): Recognize your products on photos of retail shelves. Activate a plan, upload your product catalog, train it, publish a version, and send shelf photos to the API. - [Disks and scaling](https://onkilby.com/docs/disks-scaling.md): Persistent disks, several instances and autoscaling on CPU, and how they count against the workspace limits. - [Logs, metrics and the shell](https://onkilby.com/docs/logs-metrics-shell.md): Read what a service prints, watch its CPU and memory, and open a shell in a running container. - [Log streams](https://onkilby.com/docs/log-streams.md): Send the logs of your services to Datadog, an HTTPS endpoint, syslog over TLS, Grafana Loki or Better Stack. The page says whether it is available yet, and how it behaves when a destination is slow or down. - [Blueprints](https://onkilby.com/docs/blueprints.md): Describe a stack of services and databases in one kilby.yaml, read the plan, then apply it. ## Data - [Databases](https://onkilby.com/docs/databases.md): Managed Postgres with pgvector: create, connect, resize, back up and restore to any second of the last week. - [Key Value (Redis-compatible)](https://onkilby.com/docs/key-value.md): A managed Redis-compatible store (Valkey) for queues, caches and rate limits. The page says whether it is available yet, and how it works when it is. ## Teams and security - [Workspaces, roles and 2FA](https://onkilby.com/docs/workspaces.md): What a workspace is, the four roles and what each can do, adding members, two-factor authentication and sessions. - [Security and isolation](https://onkilby.com/docs/security.md): How workspaces are kept apart, how a service is confined, what is encrypted, and what Kilby does not claim. - [Kilby AI](https://onkilby.com/docs/kilby-ai.md): What Kilby AI does with a failed deploy and in Kilby DNS, exactly what is sent to Google and what never is, its budget, and how to turn it on and off. ## Automate - [API keys and the API](https://onkilby.com/docs/api.md): Create an API key, pick its role, call the REST API, and find the full reference and the OpenAPI description. - [Webhooks and notifications](https://onkilby.com/docs/webhooks.md): Get told when a deploy fails, a cron job fails or a shell is opened: by email, in a Slack channel, by signed webhooks, or call a deploy hook from CI. - [CLI](https://onkilby.com/docs/cli.md): The kilby command line tool: logging in, listing services, reading logs, setting variables, and the exact help of each command. ## Help - [Limits and quotas](https://onkilby.com/docs/limits.md): What a workspace may run, every other limit, and what Kilby says when you reach one. - [Troubleshooting](https://onkilby.com/docs/troubleshooting.md): The failures Kilby recognises, the exact message each one gives, and what to change. - [Status page](https://onkilby.com/docs/status.md): Whether Kilby is up: the public status page and its JSON, what each component means, how a state is decided, and what the page cannot tell you. ## Legal - [Terms of Service](https://onkilby.com/docs/terms.md): The agreement between you and Neuramorphic for using Kilby: accounts, your content, acceptable use, charges, suspension and termination, and liability. - [Privacy Policy](https://onkilby.com/docs/privacy.md): What personal data Kilby holds, why, who receives it, how long it is kept, where it is processed and how to exercise your rights. - [Subprocessors](https://onkilby.com/docs/subprocessors.md): The companies that process data for Kilby, what each does, what data it sees, where, and whether it is active today. - [Data Processing Addendum](https://onkilby.com/docs/dpa.md): How Neuramorphic handles personal data inside the content you run on Kilby: instructions, security, subprocessors, transfers, incidents, deletion and audits. - [Acceptable Use Policy](https://onkilby.com/docs/aup.md): What you may not do with Kilby, how to report abuse, and what Neuramorphic does when a service or an account breaks these rules. ## Reference - [API reference](https://onkilby.com/api/docs): every endpoint of the REST API, with examples, errors and permissions (HTML). - [OpenAPI description](https://onkilby.com/api/v1/openapi.json): the whole API as an OpenAPI 3.1 document. No API key needed. - [Blueprint reference](https://onkilby.com/docs/blueprints): every field of a kilby.yaml file (HTML). - [Blueprint JSON Schema](https://onkilby.com/schemas/kilby-blueprint.json): the schema of a kilby.yaml file, for editors and validators. - [Public list prices](https://onkilby.com/api/v1/pricing): instance types and prices as JSON. No API key needed. - [Platform status](https://onkilby.com/status): whether Kilby is up, per component, with the last 90 days (HTML). The same data as JSON is at https://onkilby.com/status.json.