# Overlay Web

> Developer and self-hosting documentation for the Overlay web app.

## Docs

- [Adjust an administrative budget](https://getoverlay.io/docs/api-reference/endpoints/administration/adjust-an-administrative-budget.md)
- [Grant an administrative principal](https://getoverlay.io/docs/api-reference/endpoints/administration/grant-an-administrative-principal.md)
- [List administrative principals](https://getoverlay.io/docs/api-reference/endpoints/administration/list-administrative-principals.md)
- [List administrative usage](https://getoverlay.io/docs/api-reference/endpoints/administration/list-administrative-usage.md)
- [List audit events](https://getoverlay.io/docs/api-reference/endpoints/administration/list-audit-events.md)
- [Revoke an administrative principal](https://getoverlay.io/docs/api-reference/endpoints/administration/revoke-an-administrative-principal.md)
- [Create an automation](https://getoverlay.io/docs/api-reference/endpoints/automations/create-an-automation.md)
- [Delete an automation](https://getoverlay.io/docs/api-reference/endpoints/automations/delete-an-automation.md)
- [List automations](https://getoverlay.io/docs/api-reference/endpoints/automations/list-automations.md)
- [Run an automation](https://getoverlay.io/docs/api-reference/endpoints/automations/run-an-automation.md)
- [Test an automation draft](https://getoverlay.io/docs/api-reference/endpoints/automations/test-an-automation-draft.md)
- [Update an automation](https://getoverlay.io/docs/api-reference/endpoints/automations/update-an-automation.md)
- [Read billing settings](https://getoverlay.io/docs/api-reference/endpoints/billing/read-billing-settings.md)
- [Read subscription state](https://getoverlay.io/docs/api-reference/endpoints/billing/read-subscription-state.md)
- [Update billing settings](https://getoverlay.io/docs/api-reference/endpoints/billing/update-billing-settings.md)
- [Load signed-in app bootstrap state](https://getoverlay.io/docs/api-reference/endpoints/bootstrap/load-signed-in-app-bootstrap-state.md)
- [Read web capabilities](https://getoverlay.io/docs/api-reference/endpoints/bootstrap/read-web-capabilities.md)
- [Generate a conversation title](https://getoverlay.io/docs/api-reference/endpoints/chat/generate-a-conversation-title.md)
- [List chat starter suggestions](https://getoverlay.io/docs/api-reference/endpoints/chat/list-chat-starter-suggestions.md)
- [Add a conversation message](https://getoverlay.io/docs/api-reference/endpoints/conversations/add-a-conversation-message.md)
- [Create a conversation](https://getoverlay.io/docs/api-reference/endpoints/conversations/create-a-conversation.md)
- [Create a stream auth token](https://getoverlay.io/docs/api-reference/endpoints/conversations/create-a-stream-auth-token.md)
- [Delete a conversation](https://getoverlay.io/docs/api-reference/endpoints/conversations/delete-a-conversation.md)
- [Delete a conversation message](https://getoverlay.io/docs/api-reference/endpoints/conversations/delete-a-conversation-message.md)
- [List or read conversations](https://getoverlay.io/docs/api-reference/endpoints/conversations/list-or-read-conversations.md)
- [Plan extension actions for an Act turn](https://getoverlay.io/docs/api-reference/endpoints/conversations/plan-extension-actions-for-an-act-turn.md)
- [Run an Act turn](https://getoverlay.io/docs/api-reference/endpoints/conversations/run-an-act-turn.md)
- [Stop a running conversation turn](https://getoverlay.io/docs/api-reference/endpoints/conversations/stop-a-running-conversation-turn.md)
- [Update a conversation](https://getoverlay.io/docs/api-reference/endpoints/conversations/update-a-conversation.md)
- [Update conversation sharing](https://getoverlay.io/docs/api-reference/endpoints/conversations/update-conversation-sharing.md)
- [Wait for durable conversation changes after a cursor](https://getoverlay.io/docs/api-reference/endpoints/conversations/wait-for-durable-conversation-changes-after-a-cursor.md)
- [Create a file](https://getoverlay.io/docs/api-reference/endpoints/files/create-a-file.md)
- [Create an upload URL](https://getoverlay.io/docs/api-reference/endpoints/files/create-an-upload-url.md)
- [Delete a file](https://getoverlay.io/docs/api-reference/endpoints/files/delete-a-file.md)
- [Download file content](https://getoverlay.io/docs/api-reference/endpoints/files/download-file-content.md)
- [Ingest an uploaded document](https://getoverlay.io/docs/api-reference/endpoints/files/ingest-an-uploaded-document.md)
- [List or read files](https://getoverlay.io/docs/api-reference/endpoints/files/list-or-read-files.md)
- [Presign file access](https://getoverlay.io/docs/api-reference/endpoints/files/presign-file-access.md)
- [Search file text](https://getoverlay.io/docs/api-reference/endpoints/files/search-file-text.md)
- [Update a file](https://getoverlay.io/docs/api-reference/endpoints/files/update-a-file.md)
- [Update file sharing](https://getoverlay.io/docs/api-reference/endpoints/files/update-file-sharing.md)
- [Connect an integration](https://getoverlay.io/docs/api-reference/endpoints/integrations/connect-an-integration.md)
- [List integrations](https://getoverlay.io/docs/api-reference/endpoints/integrations/list-integrations.md)
- [Search knowledge](https://getoverlay.io/docs/api-reference/endpoints/knowledge/search-knowledge.md)
- [Create an MCP server](https://getoverlay.io/docs/api-reference/endpoints/mcp-servers/create-an-mcp-server.md)
- [Delete an MCP server](https://getoverlay.io/docs/api-reference/endpoints/mcp-servers/delete-an-mcp-server.md)
- [List MCP servers](https://getoverlay.io/docs/api-reference/endpoints/mcp-servers/list-mcp-servers.md)
- [Test an MCP server](https://getoverlay.io/docs/api-reference/endpoints/mcp-servers/test-an-mcp-server.md)
- [Update an MCP server](https://getoverlay.io/docs/api-reference/endpoints/mcp-servers/update-an-mcp-server.md)
- [Generate a video](https://getoverlay.io/docs/api-reference/endpoints/media/generate-a-video.md)
- [Generate an image](https://getoverlay.io/docs/api-reference/endpoints/media/generate-an-image.md)
- [Transcribe audio](https://getoverlay.io/docs/api-reference/endpoints/media/transcribe-audio.md)
- [Create a memory](https://getoverlay.io/docs/api-reference/endpoints/memory/create-a-memory.md)
- [Delete a memory](https://getoverlay.io/docs/api-reference/endpoints/memory/delete-a-memory.md)
- [List memories](https://getoverlay.io/docs/api-reference/endpoints/memory/list-memories.md)
- [Update a memory](https://getoverlay.io/docs/api-reference/endpoints/memory/update-a-memory.md)
- [Read the model catalog](https://getoverlay.io/docs/api-reference/endpoints/models/read-the-model-catalog.md): Pass refresh=1 to force a gateway catalog refresh.
- [Create a note](https://getoverlay.io/docs/api-reference/endpoints/notes/create-a-note.md)
- [Delete a note](https://getoverlay.io/docs/api-reference/endpoints/notes/delete-a-note.md)
- [List notes](https://getoverlay.io/docs/api-reference/endpoints/notes/list-notes.md)
- [Run the notebook agent](https://getoverlay.io/docs/api-reference/endpoints/notes/run-the-notebook-agent.md)
- [Update a note](https://getoverlay.io/docs/api-reference/endpoints/notes/update-a-note.md)
- [Complete onboarding](https://getoverlay.io/docs/api-reference/endpoints/onboarding/complete-onboarding.md)
- [Read onboarding status](https://getoverlay.io/docs/api-reference/endpoints/onboarding/read-onboarding-status.md)
- [Reset onboarding](https://getoverlay.io/docs/api-reference/endpoints/onboarding/reset-onboarding.md)
- [Delete an output](https://getoverlay.io/docs/api-reference/endpoints/outputs/delete-an-output.md)
- [Download output content](https://getoverlay.io/docs/api-reference/endpoints/outputs/download-output-content.md)
- [List outputs](https://getoverlay.io/docs/api-reference/endpoints/outputs/list-outputs.md)
- [Create a project](https://getoverlay.io/docs/api-reference/endpoints/projects/create-a-project.md)
- [Delete a project](https://getoverlay.io/docs/api-reference/endpoints/projects/delete-a-project.md)
- [List projects](https://getoverlay.io/docs/api-reference/endpoints/projects/list-projects.md)
- [Update a project](https://getoverlay.io/docs/api-reference/endpoints/projects/update-a-project.md)
- [Read settings](https://getoverlay.io/docs/api-reference/endpoints/settings/read-settings.md)
- [Update settings](https://getoverlay.io/docs/api-reference/endpoints/settings/update-settings.md)
- [Create a skill](https://getoverlay.io/docs/api-reference/endpoints/skills/create-a-skill.md)
- [Delete a skill](https://getoverlay.io/docs/api-reference/endpoints/skills/delete-a-skill.md)
- [List skills](https://getoverlay.io/docs/api-reference/endpoints/skills/list-skills.md)
- [Update a skill](https://getoverlay.io/docs/api-reference/endpoints/skills/update-a-skill.md)
- [Generate a tab group label](https://getoverlay.io/docs/api-reference/endpoints/tools/generate-a-tab-group-label.md)
- [Run code in a Daytona sandbox](https://getoverlay.io/docs/api-reference/endpoints/tools/run-code-in-a-daytona-sandbox.md)
- [Start a browser task](https://getoverlay.io/docs/api-reference/endpoints/tools/start-a-browser-task.md)
- [Create a webhook subscription](https://getoverlay.io/docs/api-reference/endpoints/webhooks/create-a-webhook-subscription.md)
- [Delete a webhook subscription](https://getoverlay.io/docs/api-reference/endpoints/webhooks/delete-a-webhook-subscription.md)
- [List webhook subscriptions](https://getoverlay.io/docs/api-reference/endpoints/webhooks/list-webhook-subscriptions.md)
- [Update a webhook subscription](https://getoverlay.io/docs/api-reference/endpoints/webhooks/update-a-webhook-subscription.md)
- [API Overview](https://getoverlay.io/docs/api-reference/overview.md): How to call the Overlay Web API and how the generated reference is maintained.
- [Admin](https://getoverlay.io/docs/api-reference/workflows/admin.md): Administration workflow endpoints for audit, principals, and usage.
- [Automations Workflow](https://getoverlay.io/docs/api-reference/workflows/automations.md): Create, test, run, and maintain scheduled AI workflows.
- [Billing Workflow](https://getoverlay.io/docs/api-reference/workflows/billing.md): Read subscription state and update billing settings.
- [Bootstrap Workflow](https://getoverlay.io/docs/api-reference/workflows/bootstrap.md): Load signed-in app state for the web shell.
- [Conversations Workflow](https://getoverlay.io/docs/api-reference/workflows/conversations.md): Create, update, stream, and stop web conversations.
- [Files Workflow](https://getoverlay.io/docs/api-reference/workflows/files.md): Upload, search, share, and read files through server-mediated routes.
- [Memory & Knowledge Workflow](https://getoverlay.io/docs/api-reference/workflows/memory-knowledge.md): Store durable user memory and search saved knowledge.
- [Changelog](https://getoverlay.io/docs/changelog.md): Overlay Web documentation and API changes.
- [Authentication Backends](https://getoverlay.io/docs/configure/authentication/backends.md): Understand the WorkOS, Better Auth, and bearer-token boundaries.
- [Authentication](https://getoverlay.io/docs/configure/authentication/index.md): Choose an Overlay session backend, identity protocol, and provider recipe.
- [OIDC Protocol](https://getoverlay.io/docs/configure/authentication/oidc.md): Configure the shared OpenID Connect contract used by private Overlay deployments.
- [Auth0](https://getoverlay.io/docs/configure/authentication/recipes/auth0.md): Use Auth0 as an alternative OIDC identity provider for Better Auth.
- [Generic OIDC](https://getoverlay.io/docs/configure/authentication/recipes/generic-oidc.md): Configure Cognito, Okta, Keycloak, and other standards-compliant OIDC providers.
- [Google Workspace](https://getoverlay.io/docs/configure/authentication/recipes/google-workspace.md): Connect Overlay directly to a customer Google Workspace through OIDC.
- [Environment Variables](https://getoverlay.io/docs/configure/environment.md): Required and optional web runtime variables for Overlay Web.
- [Providers](https://getoverlay.io/docs/configure/providers.md): Provider choices, support status, and data-processing boundaries for Overlay Web.
- [Runtime Config](https://getoverlay.io/docs/configure/runtime-config.md): Configure Overlay Web with overlay.config.json, feature gates, and environment overrides.
- [Deploy On AWS](https://getoverlay.io/docs/deploy-operate/aws.md): Build and operate Overlay on ECS with RDS PostgreSQL, ElastiCache Redis, S3, and customer-controlled CI/CD.
- [Better Auth On-Prem Runbook](https://getoverlay.io/docs/deploy-operate/better-auth-onprem-runbook.md): Operational checklist for running Overlay with Better Auth SSO in private deployments.
- [Managed Cloud Enterprise](https://getoverlay.io/docs/deploy-operate/cloud-managed.md): LayerNorm-managed single-tenant deployments for enterprise customers.
- [Compliance](https://getoverlay.io/docs/deploy-operate/compliance.md): Data residency, DPDP, retention, and licensing obligations for enterprise and managed-cloud Overlay deployments.
- [Docker On EC2](https://getoverlay.io/docs/deploy-operate/docker-ec2.md): Run a narrow Overlay sanity check on one EC2 instance with external PostgreSQL and Redis.
- [Docs Hosting](https://getoverlay.io/docs/deploy-operate/docs-hosting.md): Serve the Mintlify docs from getoverlay.io/docs or docs.getoverlay.io.
- [Enterprise Admin Onboarding](https://getoverlay.io/docs/deploy-operate/enterprise-admin-onboarding.md): Bootstrapping the first admin and managing principals in an enterprise Overlay deployment.
- [Enterprise Security Launch Checklist](https://getoverlay.io/docs/deploy-operate/enterprise-security-launch-checklist.md): Cloud-side controls required before launching Overlay for an enterprise deployment or managed-cloud tenant.
- [Enterprise Source Install](https://getoverlay.io/docs/deploy-operate/enterprise-source-install.md): Clone Overlay source, run the official image, and switch to local source builds when IT teams customize the code.
- [Self-hosted Executor integrations](https://getoverlay.io/docs/deploy-operate/executor-integrations.md): Run Executor beside Overlay as a private integration catalog, credential broker, policy engine, and tool executor.
- [One-Command Install](https://getoverlay.io/docs/deploy-operate/one-command-install.md): Install and manage a private Overlay self-hosted runtime with overlayctl.
- [Release Gates](https://getoverlay.io/docs/deploy-operate/release-gates.md): Checks to run before shipping web app or self-hosting changes.
- [Security Model](https://getoverlay.io/docs/deploy-operate/security.md): Auth, route validation, object access, and logging expectations for Overlay Web.
- [Self-Hosting](https://getoverlay.io/docs/deploy-operate/self-hosting.md): Run Overlay Web outside the hosted SaaS environment.
- [Tenancy And Role Model](https://getoverlay.io/docs/deploy-operate/tenancy.md): Single-customer deployment boundary, role model, and multi-tenant roadmap.
- [API Routes As Source Of Truth](https://getoverlay.io/docs/develop/api-source-of-truth.md): Why the web app owns backend route contracts and how other surfaces should consume them.
- [Web Architecture](https://getoverlay.io/docs/develop/architecture.md): How Overlay Web routes, services, schemas, and feature modules fit together.
- [Convex Workflow](https://getoverlay.io/docs/develop/convex-workflow.md): How to update Convex safely for Overlay Web changes.
- [Customizing Overlay](https://getoverlay.io/docs/develop/customization.md): Brand, theme, navigation, extensions, and feature visibility for enterprise deployments.
- [Adding Feature Modules](https://getoverlay.io/docs/develop/feature-modules.md): Package boundaries, module checklist, and settings panel registration.
- [Local Integrations](https://getoverlay.io/docs/develop/local-integrations.md): Run provider-dependent web features during local development.
- [Automations](https://getoverlay.io/docs/help/automations.md): How to create, test, and run scheduled automations in Overlay.
- [Chat](https://getoverlay.io/docs/help/chat.md): How to start, manage, and stop chats in Overlay.
- [FAQ](https://getoverlay.io/docs/help/faq.md): Frequently asked questions for Overlay users.
- [Files](https://getoverlay.io/docs/help/files.md): How to upload, search, share, and download files in Overlay.
- [Help Center](https://getoverlay.io/docs/help/index.md): Help for using Overlay as a workspace user.
- [Memory](https://getoverlay.io/docs/help/memory.md): How to save, edit, and delete memories in Overlay.
- [Projects](https://getoverlay.io/docs/help/projects.md): How to organize chats, notes, and files into projects.
- [Settings](https://getoverlay.io/docs/help/settings.md): How to manage account, billing, integrations, and preferences in Overlay.
- [Overlay Web](https://getoverlay.io/docs/introduction.md): Developer and self-hosting documentation for the Overlay web app.
- [Licensing](https://getoverlay.io/docs/legal/licensing.md): License boundaries for Overlay Web and related packages.
- [Security Reporting](https://getoverlay.io/docs/legal/security-reporting.md): How to handle vulnerabilities and security-sensitive docs updates.
- [Self-Hosting Obligations](https://getoverlay.io/docs/legal/self-hosting-obligations.md): Operational and branding obligations for self-hosted Overlay Web deployments.
- [Quickstart](https://getoverlay.io/docs/start/quickstart.md): Run Overlay Web locally against the development Convex backend.
- [Repository Map](https://getoverlay.io/docs/start/repository-map.md): Where the web app code lives and which directories own each boundary.

## OpenAPI Specs

- [overlay-web.openapi](https://getoverlay.io/docs/openapi/overlay-web.openapi.json)