# Overlay > Documentation for Overlay: using the web app, self-hosting, and building on the API. - [Overlay docs](https://getoverlay.io/docs/introduction.md): Use Overlay, run it yourself, or build on it. - [Get started](https://getoverlay.io/docs/help/index.md): Sign up, find your way around, and bring your team in. - [Work](https://getoverlay.io/docs/help/work.md): Track tasks with your team and your agents as a list, a board or a timeline. - [Agents](https://getoverlay.io/docs/help/agents.md): What agents are in Overlay, the kinds you can create, and how to work with them. - [Claude Code and Codex agents](https://getoverlay.io/docs/help/other-agents.md): Run Claude Code or Codex as an agent on an Overlay Cloud computer, bring your own setup, and give it your Overlay workspace. - [Chats](https://getoverlay.io/docs/help/chat.md): AI chats, direct messages and channels, and how to work with models, attachments and approvals. - [Files and notes](https://getoverlay.io/docs/help/files.md): Upload files, write notes, and find what Overlay generated for you. - [Memories](https://getoverlay.io/docs/help/memory.md): What Overlay remembers about you, and how to review, edit and delete it. - [Extensions](https://getoverlay.io/docs/help/extensions.md): Connect your other apps, write skills, and add your own MCP servers. - [Tools](https://getoverlay.io/docs/help/tools.md): What chat and agents can do in Overlay, and who gets which tools. - [Automations](https://getoverlay.io/docs/help/automations.md): Run instructions on a schedule, test them, and read what they did. - [Connect ChatGPT, Claude, and other apps](https://getoverlay.io/docs/help/connect-other-apps.md): Let other AI apps use your Overlay workspace: notes, files, memory, knowledge, and your agents. - [Plans and credit](https://getoverlay.io/docs/help/billing.md): How free and paid workspaces work, what credit pays for, and what happens when it runs out. - [Settings](https://getoverlay.io/docs/help/settings.md): A tour of the settings pages and what each one controls. - [FAQ](https://getoverlay.io/docs/help/faq.md): Answers to common questions about Overlay, your data and your account. - [Self-hosting overview](https://getoverlay.io/docs/self-hosting/overview.md): What you run when you host Overlay yourself, and where to start. - [One-command install](https://getoverlay.io/docs/self-hosting/install/one-command.md): Install and manage a private Overlay self-hosted runtime with overlayctl. - [Self-hosted Convex](https://getoverlay.io/docs/self-hosting/install/self-hosted-convex.md): Run Overlay on the official open-source Convex backend with PostgreSQL persistence and S3-compatible storage — full feature parity with Convex Cloud. - [Docker on one host](https://getoverlay.io/docs/self-hosting/install/docker.md): Run a narrow Overlay sanity check on one EC2 instance with a self-hosted Convex backend, external PostgreSQL for Better Auth, and Redis. - [AWS reference architecture](https://getoverlay.io/docs/self-hosting/install/aws.md): Build and operate Overlay on ECS with a self-hosted Convex backend, RDS PostgreSQL, ElastiCache Redis, S3, and customer-controlled CI/CD. - [Install from source](https://getoverlay.io/docs/self-hosting/install/from-source.md): Clone Overlay source, run the official image, and switch to local source builds when IT teams customize the code. - [Node.js without Docker](https://getoverlay.io/docs/self-hosting/install/node.md): Build and run the Overlay web app as a plain Node.js process. - [Runtime config](https://getoverlay.io/docs/self-hosting/configure/runtime-config.md): Configure Overlay Web with overlay.config.json, feature gates, and environment overrides. - [Environment variables](https://getoverlay.io/docs/self-hosting/configure/environment.md): Required and optional web runtime variables for Overlay Web. - [Providers](https://getoverlay.io/docs/self-hosting/configure/providers.md): Provider choices, support status, and data-processing boundaries for Overlay Web. - [Search and embeddings](https://getoverlay.io/docs/self-hosting/configure/search-and-embeddings.md): Create searchable personal and organization brains with durable sources, grounded chat, and authorization-aware sharing. - [Authentication](https://getoverlay.io/docs/self-hosting/configure/authentication/index.md): Choose an Overlay session backend, identity protocol, and provider recipe. - [Authentication backends](https://getoverlay.io/docs/self-hosting/configure/authentication/backends.md): Understand the WorkOS, Better Auth, and bearer-token boundaries. - [OIDC protocol](https://getoverlay.io/docs/self-hosting/configure/authentication/oidc.md): Configure the shared OpenID Connect contract used by private Overlay deployments. - [Google Workspace](https://getoverlay.io/docs/self-hosting/configure/authentication/recipes/google-workspace.md): Connect Overlay directly to a customer Google Workspace through OIDC. - [Auth0](https://getoverlay.io/docs/self-hosting/configure/authentication/recipes/auth0.md): Use Auth0 as an alternative OIDC identity provider for Better Auth. - [Generic OIDC](https://getoverlay.io/docs/self-hosting/configure/authentication/recipes/generic-oidc.md): Configure Cognito, Okta, Keycloak, and other standards-compliant OIDC providers. - [Administration](https://getoverlay.io/docs/self-hosting/enterprise/admin-onboarding.md): Set up the operator console, grant the first administrator, and manage roles and audit. - [Upgrades](https://getoverlay.io/docs/self-hosting/operate/upgrades.md): Move to a new Overlay release safely, and roll back if you need to. - [Backups](https://getoverlay.io/docs/self-hosting/operate/backups.md): What to back up in a self-hosted Overlay deployment, and how to restore it. - [Security model](https://getoverlay.io/docs/self-hosting/operate/security.md): Auth, route validation, object access, and logging expectations for Overlay Web. - [Security launch checklist](https://getoverlay.io/docs/self-hosting/operate/security-checklist.md): Cloud-side controls required before launching Overlay for an enterprise deployment or managed-cloud tenant. - [Release verification](https://getoverlay.io/docs/self-hosting/operate/release-verification.md): Checks to run before shipping web app or self-hosting changes. - [Better Auth runbook](https://getoverlay.io/docs/self-hosting/operate/better-auth-runbook.md): Operational checklist for running Overlay with Better Auth SSO in private deployments. - [Self-hosted Executor integrations](https://getoverlay.io/docs/self-hosting/operate/executor-integrations.md): Run Executor beside Overlay as a private integration catalog, credential broker, policy engine, and tool executor. - [Managed deployments](https://getoverlay.io/docs/self-hosting/enterprise/managed.md): LayerNorm-managed single-tenant deployments for enterprise customers. - [Tenancy and roles](https://getoverlay.io/docs/self-hosting/enterprise/tenancy.md): Single-customer deployment boundary, role model, and multi-tenant roadmap. - [Compliance](https://getoverlay.io/docs/self-hosting/enterprise/compliance.md): Data residency, DPDP, retention, and licensing obligations for enterprise and managed-cloud Overlay deployments. - [License](https://getoverlay.io/docs/self-hosting/licensing/license.md): AGPL and commercial licensing boundaries for Overlay. - [Self-hosting obligations](https://getoverlay.io/docs/self-hosting/licensing/obligations.md): Source, notice, and branding obligations for self-hosted Overlay deployments. - [Build on Overlay](https://getoverlay.io/docs/developer/index.md): Ways to connect your own tools, apps and agents to Overlay. - [Authentication](https://getoverlay.io/docs/developer/authentication.md): Which credential to use for MCP, the REST API and webhooks. - [MCP server](https://getoverlay.io/docs/developer/mcp.md): Connect any MCP client to an Overlay workspace: address, sign-in, access levels, tools and limits. - [REST API](https://getoverlay.io/docs/developer/api/overview.md): The /api/v1 web API: base URL, authentication, request shapes and errors. - [Bootstrap](https://getoverlay.io/docs/developer/api/guides/bootstrap.md): Load signed-in app state for the web shell. - [Conversations](https://getoverlay.io/docs/developer/api/guides/conversations.md): Create, update, run, and stop web conversations. - [Files](https://getoverlay.io/docs/developer/api/guides/files.md): Upload, search, share, and read files through server-mediated routes. - [Memory and knowledge](https://getoverlay.io/docs/developer/api/guides/memory.md): Store durable user memory and search saved knowledge. - [Automations](https://getoverlay.io/docs/developer/api/guides/automations.md): Create, test, run, and maintain scheduled AI workflows. - [Billing](https://getoverlay.io/docs/developer/api/guides/billing.md): Read a workspace's plan, credit and usage. - [Update the signed-in account profile](https://getoverlay.io/docs/developer/api/reference/account/update-the-signed-in-account-profile.md) - [Read an authorized account profile photo](https://getoverlay.io/docs/developer/api/reference/account/read-an-authorized-account-profile-photo.md) - [Upload an account profile photo](https://getoverlay.io/docs/developer/api/reference/account/upload-an-account-profile-photo.md): Accepts a multipart `file` image. The server authorizes the account before parsing or processing the upload. - [Agents asking agents: list who can be asked, ask one, or read a reply that was still being written](https://getoverlay.io/docs/developer/api/reference/agents/agents-asking-agents:-list-who-can-be-asked-ask-one-or-read-a-reply-that-was-still-being-written.md) - [List automations](https://getoverlay.io/docs/developer/api/reference/automations/list-automations.md) - [Create an automation](https://getoverlay.io/docs/developer/api/reference/automations/create-an-automation.md) - [Delete an automation](https://getoverlay.io/docs/developer/api/reference/automations/delete-an-automation.md) - [Update an automation](https://getoverlay.io/docs/developer/api/reference/automations/update-an-automation.md) - [Run an automation](https://getoverlay.io/docs/developer/api/reference/automations/run-an-automation.md) - [Test an automation draft](https://getoverlay.io/docs/developer/api/reference/automations/test-an-automation-draft.md) - [Load signed-in app bootstrap state](https://getoverlay.io/docs/developer/api/reference/bootstrap/load-signed-in-app-bootstrap-state.md) - [Read web capabilities](https://getoverlay.io/docs/developer/api/reference/bootstrap/read-web-capabilities.md) - [List caller-visible workspace computers](https://getoverlay.io/docs/developer/api/reference/computers/list-caller-visible-workspace-computers.md) - [Provision a workspace computer (idempotent per owner)](https://getoverlay.io/docs/developer/api/reference/computers/provision-a-workspace-computer-idempotent-per-owner.md) - [Read one workspace computer](https://getoverlay.io/docs/developer/api/reference/computers/read-one-workspace-computer.md) - [Destroy a computer and its backing machine](https://getoverlay.io/docs/developer/api/reference/computers/destroy-a-computer-and-its-backing-machine.md) - [Take or release human control of a computer](https://getoverlay.io/docs/developer/api/reference/computers/take-or-release-human-control-of-a-computer.md) - [Issue a short-lived desktop stream ticket](https://getoverlay.io/docs/developer/api/reference/computers/issue-a-short-lived-desktop-stream-ticket.md) - [Resume a stopped computer machine](https://getoverlay.io/docs/developer/api/reference/computers/resume-a-stopped-computer-machine.md) - [Stop a running computer machine](https://getoverlay.io/docs/developer/api/reference/computers/stop-a-running-computer-machine.md) - [List or read conversations](https://getoverlay.io/docs/developer/api/reference/conversations/list-or-read-conversations.md) - [Create a conversation](https://getoverlay.io/docs/developer/api/reference/conversations/create-a-conversation.md) - [Delete a conversation](https://getoverlay.io/docs/developer/api/reference/conversations/delete-a-conversation.md) - [Update a conversation](https://getoverlay.io/docs/developer/api/reference/conversations/update-a-conversation.md) - [Run an Act turn](https://getoverlay.io/docs/developer/api/reference/conversations/run-an-act-turn.md) - [Wait for durable conversation changes after a cursor](https://getoverlay.io/docs/developer/api/reference/conversations/wait-for-durable-conversation-changes-after-a-cursor.md) - [Add a conversation message](https://getoverlay.io/docs/developer/api/reference/conversations/add-a-conversation-message.md) - [Delete a conversation message](https://getoverlay.io/docs/developer/api/reference/conversations/delete-a-conversation-message.md) - [Read the authoritative AgentRun for a conversation](https://getoverlay.io/docs/developer/api/reference/conversations/read-the-authoritative-agentrun-for-a-conversation.md) - [Approve or deny a waiting AgentRun tool call](https://getoverlay.io/docs/developer/api/reference/conversations/approve-or-deny-a-waiting-agentrun-tool-call.md) - [Provide requested input to a waiting personal or native Harness AgentRun](https://getoverlay.io/docs/developer/api/reference/conversations/provide-requested-input-to-a-waiting-personal-or-native-harness-agentrun.md) - [Update conversation sharing](https://getoverlay.io/docs/developer/api/reference/conversations/update-conversation-sharing.md) - [Stop a running conversation turn](https://getoverlay.io/docs/developer/api/reference/conversations/stop-a-running-conversation-turn.md) - [Stream the complete public transcript of an assistant message](https://getoverlay.io/docs/developer/api/reference/conversations/stream-the-complete-public-transcript-of-an-assistant-message.md) - [List or read files](https://getoverlay.io/docs/developer/api/reference/files/list-or-read-files.md) - [Create a file](https://getoverlay.io/docs/developer/api/reference/files/create-a-file.md) - [Delete a file](https://getoverlay.io/docs/developer/api/reference/files/delete-a-file.md) - [Update a file](https://getoverlay.io/docs/developer/api/reference/files/update-a-file.md) - [Download file content](https://getoverlay.io/docs/developer/api/reference/files/download-file-content.md) - [Ingest an uploaded document](https://getoverlay.io/docs/developer/api/reference/files/ingest-an-uploaded-document.md) - [Presign file access](https://getoverlay.io/docs/developer/api/reference/files/presign-file-access.md) - [Search file text](https://getoverlay.io/docs/developer/api/reference/files/search-file-text.md) - [Update file sharing](https://getoverlay.io/docs/developer/api/reference/files/update-file-sharing.md) - [Create an upload URL](https://getoverlay.io/docs/developer/api/reference/files/create-an-upload-url.md) - [Generate an image](https://getoverlay.io/docs/developer/api/reference/media/generate-an-image.md) - [Generate a video](https://getoverlay.io/docs/developer/api/reference/media/generate-a-video.md) - [Transcribe audio](https://getoverlay.io/docs/developer/api/reference/media/transcribe-audio.md) - [List integrations](https://getoverlay.io/docs/developer/api/reference/integrations/list-integrations.md) - [Connect an integration](https://getoverlay.io/docs/developer/api/reference/integrations/connect-an-integration.md) - [Search knowledge](https://getoverlay.io/docs/developer/api/reference/knowledge/search-knowledge.md) - [List MCP servers](https://getoverlay.io/docs/developer/api/reference/mcp-servers/list-mcp-servers.md) - [Create an MCP server](https://getoverlay.io/docs/developer/api/reference/mcp-servers/create-an-mcp-server.md) - [Delete an MCP server](https://getoverlay.io/docs/developer/api/reference/mcp-servers/delete-an-mcp-server.md) - [Update an MCP server](https://getoverlay.io/docs/developer/api/reference/mcp-servers/update-an-mcp-server.md) - [Start an OAuth authorization for an MCP server](https://getoverlay.io/docs/developer/api/reference/mcp-servers/start-an-oauth-authorization-for-an-mcp-server.md) - [Disconnect OAuth for an MCP server](https://getoverlay.io/docs/developer/api/reference/mcp-servers/disconnect-oauth-for-an-mcp-server.md) - [Test an MCP server](https://getoverlay.io/docs/developer/api/reference/mcp-servers/test-an-mcp-server.md) - [List memories](https://getoverlay.io/docs/developer/api/reference/memory/list-memories.md) - [Create a memory](https://getoverlay.io/docs/developer/api/reference/memory/create-a-memory.md) - [Delete a memory](https://getoverlay.io/docs/developer/api/reference/memory/delete-a-memory.md) - [Update a memory](https://getoverlay.io/docs/developer/api/reference/memory/update-a-memory.md) - [Read the model catalog](https://getoverlay.io/docs/developer/api/reference/models/read-the-model-catalog.md): Pass refresh=1 to force a gateway catalog refresh. - [List notes](https://getoverlay.io/docs/developer/api/reference/notes/list-notes.md) - [Create a note](https://getoverlay.io/docs/developer/api/reference/notes/create-a-note.md) - [Delete a note](https://getoverlay.io/docs/developer/api/reference/notes/delete-a-note.md) - [Update a note](https://getoverlay.io/docs/developer/api/reference/notes/update-a-note.md) - [List outputs](https://getoverlay.io/docs/developer/api/reference/outputs/list-outputs.md) - [Delete an output](https://getoverlay.io/docs/developer/api/reference/outputs/delete-an-output.md) - [Download output content](https://getoverlay.io/docs/developer/api/reference/outputs/download-output-content.md) - [List model provider connections](https://getoverlay.io/docs/developer/api/reference/model-providers/list-model-provider-connections.md) - [Create a model provider connection](https://getoverlay.io/docs/developer/api/reference/model-providers/create-a-model-provider-connection.md) - [Delete a model provider connection](https://getoverlay.io/docs/developer/api/reference/model-providers/delete-a-model-provider-connection.md) - [Update a model provider connection](https://getoverlay.io/docs/developer/api/reference/model-providers/update-a-model-provider-connection.md) - [Test a model provider connection and discover models](https://getoverlay.io/docs/developer/api/reference/model-providers/test-a-model-provider-connection-and-discover-models.md) - [Read settings](https://getoverlay.io/docs/developer/api/reference/settings/read-settings.md) - [Update settings](https://getoverlay.io/docs/developer/api/reference/settings/update-settings.md) - [List skills](https://getoverlay.io/docs/developer/api/reference/skills/list-skills.md) - [Create a skill](https://getoverlay.io/docs/developer/api/reference/skills/create-a-skill.md) - [Delete a skill](https://getoverlay.io/docs/developer/api/reference/skills/delete-a-skill.md) - [Update a skill](https://getoverlay.io/docs/developer/api/reference/skills/update-a-skill.md) - [Read subscription state](https://getoverlay.io/docs/developer/api/reference/billing/read-subscription-state.md) - [List webhook subscriptions](https://getoverlay.io/docs/developer/api/reference/webhooks/list-webhook-subscriptions.md) - [Create a webhook subscription](https://getoverlay.io/docs/developer/api/reference/webhooks/create-a-webhook-subscription.md) - [Delete a webhook subscription](https://getoverlay.io/docs/developer/api/reference/webhooks/delete-a-webhook-subscription.md) - [Update a webhook subscription](https://getoverlay.io/docs/developer/api/reference/webhooks/update-a-webhook-subscription.md) - [Read the workspace icon](https://getoverlay.io/docs/developer/api/reference/workspaces/read-the-workspace-icon.md) - [Upload a workspace icon](https://getoverlay.io/docs/developer/api/reference/workspaces/upload-a-workspace-icon.md): Accepts a multipart `file` image. The server authorizes a workspace owner or admin before parsing or processing the upload. - [Set a preset workspace icon](https://getoverlay.io/docs/developer/api/reference/workspaces/set-a-preset-workspace-icon.md) - [Read the current member profile in a workspace](https://getoverlay.io/docs/developer/api/reference/workspaces/read-the-current-member-profile-in-a-workspace.md) - [Update the current member profile in a workspace](https://getoverlay.io/docs/developer/api/reference/workspaces/update-the-current-member-profile-in-a-workspace.md) - [Read an authorized workspace profile photo](https://getoverlay.io/docs/developer/api/reference/workspaces/read-an-authorized-workspace-profile-photo.md) - [Upload a workspace profile photo](https://getoverlay.io/docs/developer/api/reference/workspaces/upload-a-workspace-profile-photo.md): Accepts a multipart `file` image. The server authorizes active workspace membership before parsing or processing the upload. - [Webhooks](https://getoverlay.io/docs/developer/webhooks.md): Receive Overlay events at your own endpoint, verify them and handle retries. - [Run Overlay locally](https://getoverlay.io/docs/developer/contribute/run-locally.md): Clone Overlay Web and run the hosted-development profile locally. - [Repository map](https://getoverlay.io/docs/developer/contribute/repository-map.md): Where the web app code lives and which directories own each boundary. - [Architecture](https://getoverlay.io/docs/developer/contribute/architecture.md): How Overlay Web routes, services, schemas, and feature modules fit together. - [Local integrations](https://getoverlay.io/docs/developer/contribute/local-integrations.md): Run provider-dependent web features during local development. - [Reporting a vulnerability](https://getoverlay.io/docs/developer/security.md): How to handle vulnerabilities and security-sensitive docs updates. - [Changelog](https://getoverlay.io/docs/changelog.md): Overlay Web documentation and API changes. ## OpenAPI Specs - [overlay-web.openapi](/docs/openapi/overlay-web.openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.