# UseZombie

## Docs

- [Delete a platform LLM key](https://docs.usezombie.com/api-reference/admin/delete-a-platform-llm-key.md): Removes a platform-wide LLM provider key. Workspaces without BYOK keys will no longer be able to use this provider.
- [List platform LLM keys](https://docs.usezombie.com/api-reference/admin/list-platform-llm-keys.md): Lists all configured platform-wide LLM provider keys. These are shared keys that workspaces fall back to when no BYOK key is configured.
- [Set a platform LLM key](https://docs.usezombie.com/api-reference/admin/set-a-platform-llm-key.md): Configures a platform-wide LLM provider key by referencing a workspace that has a BYOK key stored. The platform key proxies through the referenced workspace's credential.
- [Complete an auth session](https://docs.usezombie.com/api-reference/authentication/complete-an-auth-session.md): Called by the web frontend after successful OAuth to attach a token to the pending session. The CLI's next poll will receive the token.
- [GitHub OAuth callback](https://docs.usezombie.com/api-reference/authentication/github-oauth-callback.md): Handles the GitHub OAuth redirect. Exchanges the authorization code for an access token and redirects the user back to the app.
- [Poll auth session status](https://docs.usezombie.com/api-reference/authentication/poll-auth-session-status.md): Polls a pending auth session. The CLI calls this repeatedly until status transitions to 'complete' (token available) or 'expired'.
- [Start a CLI login session](https://docs.usezombie.com/api-reference/authentication/start-a-cli-login-session.md): Creates a device-code style auth session. Returns a session ID and a login URL to present to the user in their browser.
- [Tenant billing snapshot](https://docs.usezombie.com/api-reference/billing/tenant-billing-snapshot.md): Returns the tenant-scoped billing row created at signup. The single row carries the plan tier, SKU, and free-credit balance shared across every workspace the tenant owns. Debited by the worker as zombie runs complete.
- [Delete LLM credential](https://docs.usezombie.com/api-reference/credentials/delete-llm-credential.md): Removes the stored BYOK LLM API key for the workspace. Future runs will fall back to platform-provided keys if available.
- [Get LLM credential status](https://docs.usezombie.com/api-reference/credentials/get-llm-credential-status.md): Returns whether a BYOK LLM key is configured for the workspace and which provider it belongs to. Never returns the actual key.
- [Set LLM credential](https://docs.usezombie.com/api-reference/credentials/set-llm-credential.md): Stores or replaces the BYOK LLM API key for a workspace. The key is encrypted at rest and never returned in API responses.
- [Error Codes](https://docs.usezombie.com/api-reference/error-codes.md): All error responses from zombied use RFC 7807 (application/problem+json). This page lists every error code, its HTTP status, and common causes.
- [Liveness check](https://docs.usezombie.com/api-reference/health/liveness-check.md): Returns 200 as long as the process is alive and able to serve HTTP. Does not probe dependencies — use /readyz for readiness (database + queue).
- [Prometheus metrics](https://docs.usezombie.com/api-reference/health/prometheus-metrics.md): Returns Prometheus-format metrics for scraping by monitoring infrastructure.
- [Readiness probe](https://docs.usezombie.com/api-reference/health/readiness-probe.md): Kubernetes-style readiness probe. Returns 200 when both the database and the Redis queue are reachable; returns 503 fail-closed if either dependency is degraded.
- [API Reference](https://docs.usezombie.com/api-reference/introduction.md): UseZombie Control Plane API — deploy, observe, and control zombies programmatically.
- [Create a workspace](https://docs.usezombie.com/api-reference/workspaces/create-a-workspace.md): Creates a new workspace linked to a GitHub repository. Returns the workspace ID and a GitHub App install URL if the app is not yet installed on the repo.
- [Pause or unpause a workspace](https://docs.usezombie.com/api-reference/workspaces/pause-or-unpause-a-workspace.md): Toggles the paused state of a workspace. When paused, no new runs will be started and queued runs will be held. Uses optimistic concurrency via the version field.
- [Sync specs from repo](https://docs.usezombie.com/api-reference/workspaces/sync-specs-from-repo.md): Reads PENDING_*.md spec files from the repository's default branch and upserts them into the control plane. Returns the count of newly synced specs.
- [Budgets and cost control](https://docs.usezombie.com/billing/budgets.md): Per-zombie dollar ceilings, tenant-wide spend caps, and how debits work.
- [Plans](https://docs.usezombie.com/billing/plans.md): Hobby and Scale — what you get and how credits work.
- [Changelog](https://docs.usezombie.com/changelog.md): Stay up to date with UseZombie product updates, new features, and improvements.
- [Configuration](https://docs.usezombie.com/cli/configuration.md): Configuration precedence and environment variables.
- [Global flags](https://docs.usezombie.com/cli/flags.md): Flags available on all zombiectl commands.
- [Install](https://docs.usezombie.com/cli/install.md): Install the zombiectl CLI.
- [Command reference](https://docs.usezombie.com/cli/zombiectl.md): Complete zombiectl command reference.
- [Key concepts](https://docs.usezombie.com/concepts.md): The four nouns, the credential firewall, and how credits flow.
- [How it works](https://docs.usezombie.com/how-it-works.md): Sandboxed runtime, credential firewall, always-on execution, and observability.
- [Introduction](https://docs.usezombie.com/index.md): The runtime for agents that touch real infrastructure — without giving them your credentials.
- [Zombie memory](https://docs.usezombie.com/memory.md): How zombies remember across events — what memory is, what it solves, log vs memory, and how to wire it into custom zombies.
- [Credentials](https://docs.usezombie.com/operator/configuration/credentials.md): Credential injection and lifecycle.
- [Environment variables](https://docs.usezombie.com/operator/configuration/environment.md): All configuration variables by role.
- [Sandbox configuration](https://docs.usezombie.com/operator/configuration/sandbox.md): Resource limits and isolation policies.
- [API server](https://docs.usezombie.com/operator/deployment/api-server.md): Deploy zombied in API mode on Fly.io.
- [Architecture overview](https://docs.usezombie.com/operator/deployment/architecture.md): System components and runtime boundary.
- [Executor sidecar](https://docs.usezombie.com/operator/deployment/executor.md): The sandboxed execution service.
- [Worker](https://docs.usezombie.com/operator/deployment/worker.md): Deploy zombied in worker mode on bare-metal.
- [Error codes](https://docs.usezombie.com/operator/observability/error-codes.md): UZ-* error code reference for operators.
- [Metrics reference](https://docs.usezombie.com/operator/observability/metrics.md): Prometheus metrics exposed by the zombied control plane at /metrics.
- [Observability overview](https://docs.usezombie.com/operator/observability/overview.md): Three-layer observability: Grafana, PostHog, and a Postgres-backed audit layer.
- [Posthog events](https://docs.usezombie.com/operator/observability/posthog-events.md)
- [Doctor](https://docs.usezombie.com/operator/operations/doctor.md): Health check and diagnostics.
- [Fleet management](https://docs.usezombie.com/operator/operations/fleet.md): Worker fleet drain, rollover, and canary deploy.
- [Security model](https://docs.usezombie.com/operator/security/model.md): Fail-closed execution with separate runtime boundaries.
- [Roles and access control](https://docs.usezombie.com/operator/security/rbac.md): Role-based access control for workspaces.
- [Sandbox enforcement](https://docs.usezombie.com/operator/security/sandbox.md): Four isolation layers on every agent execution.
- [Quickstart](https://docs.usezombie.com/quickstart.md): Sign up, run your first zombie, verify credits in under ten minutes.
- [Managing workspaces](https://docs.usezombie.com/workspaces/managing.md): Create, list, and remove workspaces.
- [Workspaces](https://docs.usezombie.com/workspaces/overview.md): What a workspace is and how it relates to your tenant.
- [Workspace credentials](https://docs.usezombie.com/zombies/credentials.md): The vault your zombies read from — and why the agent never sees the raw secret.
- [Installing a zombie](https://docs.usezombie.com/zombies/install.md): Scaffold a zombie from a bundled template with `zombiectl install`.
- [Zombies](https://docs.usezombie.com/zombies/overview.md): What a zombie is, the lifecycle it moves through, and how it relates to your workspace.
- [Starting, observing, and stopping](https://docs.usezombie.com/zombies/running.md): The `up`, `status`, `kill`, and `logs` commands — the zombie control plane.
- [Authoring skills](https://docs.usezombie.com/zombies/skills.md): The `SKILL.md` and `TRIGGER.md` file pair — how a zombie is defined end-to-end.
- [Templates](https://docs.usezombie.com/zombies/templates.md): Bundled zombie templates — what each does, how they are structured, and how to write your own.
- [Webhooks](https://docs.usezombie.com/zombies/webhooks.md): How external systems deliver events to your zombie, and how the platform authenticates them.

## OpenAPI Specs

- [openapi](https://raw.githubusercontent.com/usezombie/usezombie/main/public/openapi.json)

## Optional

- [Website](https://usezombie.com)
- [GitHub](https://github.com/usezombie/usezombie)