# Poolside

## Docs

- [Agent instructions](https://docs.poolside.ai/agent-instructions.md): Control how Poolside agents behave using agent instructions and instruction files.
- [Authentication](https://docs.poolside.ai/api/authentication.md): Create developer and service account API keys and use them to authenticate Poolside API requests.
- [OpenAI API examples](https://docs.poolside.ai/api/openai-api-examples.md): Make OpenAI-compatible API requests to Poolside models.
- [API overview](https://docs.poolside.ai/api/overview.md): Get started with Poolside APIs and find the right endpoints for your workflow.
- [Automated mode](https://docs.poolside.ai/cli/automated-mode.md): Use `pool exec` to send a one-shot prompt and exit.
- [CLI reference](https://docs.poolside.ai/cli/cli-reference.md): Current command and flag reference for the Poolside Agent CLI.
- [Editor integration (ACP)](https://docs.poolside.ai/cli/editor-integration.md): Use Poolside in Zed, JetBrains, Neovim, and other ACP-compatible editors with `pool acp`.
- [Install Poolside Agent CLI](https://docs.poolside.ai/cli/install.md): Install pool and authenticate.
- [Interactive mode](https://docs.poolside.ai/cli/interactive-mode.md): Use `pool` to work with a Poolside agent over multiple turns in the terminal.
- [Poolside Agent CLI](https://docs.poolside.ai/cli/pool.md): Work with Poolside agents from your terminal, scripts, or editor.
- [Agent auditing](https://docs.poolside.ai/console/agent-auditing.md): Investigate agent behavior in the Poolside Console by reviewing usage metrics, session history, and trajectories.
- [API keys](https://docs.poolside.ai/console/api-keys.md): Create and manage service account API keys for automation and other non-interactive workflows.
- [Audit log](https://docs.poolside.ai/console/audit-log.md): Review recorded user, service account, and resource activity across your Poolside organization.
- [Metrics](https://docs.poolside.ai/console/metrics.md): View and analyze Poolside usage metrics in the Poolside Console.
- [Models](https://docs.poolside.ai/console/models.md): Connect and manage models used by agents and IDE code completion.
- [Poolside Console](https://docs.poolside.ai/console/poolside-console.md): Understand which parts of the Poolside Console you use to manage shared resources, organization access, and settings.
- [Product branding](https://docs.poolside.ai/console/product-branding.md): Customize the appearance of Poolside interfaces for your organization with custom logos, partnership text, and banners.
- [Redaction patterns](https://docs.poolside.ai/console/redaction-patterns.md): Configure patterns to automatically redact sensitive data in agent interactions.
- [User provisioning](https://docs.poolside.ai/console/user-provisioning.md): Automatically provision and manage users with SCIM 2.0.
- [Context](https://docs.poolside.ai/context.md): Control what information Poolside uses to understand and complete your request.
- [Credentials](https://docs.poolside.ai/credentials.md): Create and manage shared credentials for agents and private repositories.
- [Backup and restore the database](https://docs.poolside.ai/deployment/backup-restore.md): Use the bundled `db-snapshot.sh` script to backup and restore the Poolside platform database.
- [AWS cost modeling](https://docs.poolside.ai/deployment/cloud/aws-eks/cost-modeling.md): Baseline AWS infrastructure costs for a Poolside deployment on Amazon EKS.
- [IAM roles for Amazon EKS](https://docs.poolside.ai/deployment/cloud/aws-eks/deployment-security/iam.md): IAM roles required by Poolside workloads in your Helm-based AWS deployment.
- [Kubernetes security](https://docs.poolside.ai/deployment/cloud/aws-eks/deployment-security/kubernetes.md): Kubernetes security controls applied by the Poolside Helm chart on Amazon EKS.
- [Install on Amazon EKS](https://docs.poolside.ai/deployment/cloud/aws-eks/install.md): Install the Poolside platform on your AWS infrastructure by using Amazon EKS and the Helm deployment bundle.
- [Model inference on Amazon EKS](https://docs.poolside.ai/deployment/cloud/aws-eks/model-inference.md): Configure model inference for your Helm-based Amazon EKS deployment, using local GPU workloads or external OpenAI-compatible API endpoints.
- [Amazon EKS deployment](https://docs.poolside.ai/deployment/cloud/aws-eks/overview.md): Overview of deploying Poolside on Amazon EKS by using Helm.
- [Reference architecture](https://docs.poolside.ai/deployment/cloud/aws-eks/reference-architecture.md): AWS reference architecture for Poolside on Amazon EKS, including the architecture diagram, AWS resources, and key design decisions.
- [Install on OpenShift](https://docs.poolside.ai/deployment/cloud/openshift/install.md): Install the Poolside platform on OpenShift by using the Helm deployment bundle.
- [Model inference on OpenShift](https://docs.poolside.ai/deployment/cloud/openshift/model-inference.md): Deploy Poolside models on OpenShift by using the inference-stack chart.
- [OpenShift deployment](https://docs.poolside.ai/deployment/cloud/openshift/overview.md): Overview of deploying Poolside on Red Hat OpenShift by using Helm.
- [Remove from OpenShift](https://docs.poolside.ai/deployment/cloud/openshift/remove.md): Instructions for removing the Poolside platform from Red Hat OpenShift.
- [Upgrade on OpenShift](https://docs.poolside.ai/deployment/cloud/openshift/upgrade.md): Upgrade an existing Poolside platform deployment on OpenShift to a new bundle.
- [Cloud deployment](https://docs.poolside.ai/deployment/cloud/overview.md): Choose a supported cloud deployment path for Poolside based on your infrastructure and model deployment requirements.
- [Install on Kubernetes](https://docs.poolside.ai/deployment/cloud/upstream-kubernetes/install.md): Install the Poolside platform on a self-managed Kubernetes cluster by using the Helm deployment bundle.
- [Model inference on upstream Kubernetes](https://docs.poolside.ai/deployment/cloud/upstream-kubernetes/model-inference.md): Choose and configure a model inference path for Poolside on upstream Kubernetes.
- [Kubernetes deployment](https://docs.poolside.ai/deployment/cloud/upstream-kubernetes/overview.md): Overview of deploying Poolside on a self-managed Kubernetes cluster by using Helm.
- [Remove from upstream Kubernetes](https://docs.poolside.ai/deployment/cloud/upstream-kubernetes/remove.md): Instructions for removing the Poolside platform from an upstream Kubernetes cluster.
- [Upgrade on Kubernetes](https://docs.poolside.ai/deployment/cloud/upstream-kubernetes/upgrade.md): Upgrade an existing Poolside platform deployment on upstream Kubernetes to a new bundle.
- [Amazon Bedrock data privacy](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/bedrock-privacy.md): How Poolside and Amazon Bedrock protect customer data in legacy Terraform-based Amazon EKS deployments that use Amazon Bedrock for inference.
- [Install on AWS](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/install.md): Instructions for installing the Poolside platform on Amazon Web Services.
- [Kubernetes overview](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/kubernetes-architecture.md): Overview of the Kubernetes architecture that powers Poolside AWS deployments, including core components, namespaces, and essential management operations.
- [Migrate from Terraform to Helm](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/migrate-to-helm.md): Transition an existing Terraform-based Amazon EKS deployment to the Helm-based deployment path.
- [Amazon EKS with Terraform (legacy)](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/overview.md): Legacy Terraform-based Amazon EKS deployment path. Maintained for existing customers; new deployments should use the Helm-based path.
- [Remove from AWS](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/remove.md): Instructions for removing the Poolside platform from Amazon Web Services.
- [Update on AWS](https://docs.poolside.ai/deployment/legacy/aws-eks-terraform/update.md): Instructions for updating the Poolside platform on Amazon Web Services.
- [OIDC authentication](https://docs.poolside.ai/deployment/oidc-for-entra-id.md): Configure an OIDC application to support using Entra for authentication to Poolside.
- [Admin toolkit](https://docs.poolside.ai/deployment/on-prem/admin.md): Guidance for managing and maintaining an on-premises Poolside deployment.
- [Certified on-premises software stack: Q1 2026](https://docs.poolside.ai/deployment/on-prem/certified-stacks/2026-01.md): Certified software components and versions for the Poolside Q1 2026 on-premises software stack.
- [Certified on-premises software stack: Q1 2026 hotfix](https://docs.poolside.ai/deployment/on-prem/certified-stacks/2026-02.md): Certified software components and versions for the Poolside Q1 2026 on-premises software stack hotfix.
- [Certified on-premises software stack: Q2 2026](https://docs.poolside.ai/deployment/on-prem/certified-stacks/2026-04.md): Certified software components and versions for the Poolside Q2 2026 on-premises software stack.
- [Certified stacks](https://docs.poolside.ai/deployment/on-prem/certified-stacks/overview.md): Certified software stacks for supported on-premises Poolside deployments.
- [On-premises deployment FAQ](https://docs.poolside.ai/deployment/on-prem/faq.md): Answers to common questions about Poolside on-premises deployments, including hardware recommendations, multi-tenant isolation, platform support, and upgrades.
- [Install on-premises](https://docs.poolside.ai/deployment/on-prem/install.md): Instructions for installing the Poolside platform in an on-premises environment.
- [On-premises deployment](https://docs.poolside.ai/deployment/on-prem/overview.md): Overview of Poolside on-premises deployments, including architecture, installation approach, and operational considerations.
- [STIG hardening considerations](https://docs.poolside.ai/deployment/on-prem/stig.md): Considerations for deploying Poolside on-premises on STIG-hardened systems, including known compatibility issues and recommended configurations.
- [Upgrade on-premises](https://docs.poolside.ai/deployment/on-prem/upgrade.md): Instructions for upgrading the Poolside platform in an on-premises environment.
- [Supported configurations](https://docs.poolside.ai/deployment/supported-configurations.md): Compare supported Poolside configurations and their minimum infrastructure and inference requirements.
- [Poolside overview](https://docs.poolside.ai/get-started/overview.md): Poolside is a secure, enterprise-grade AI platform for software engineering, designed to run entirely within your infrastructure.
- [Quickstart](https://docs.poolside.ai/get-started/quickstart.md): Start using Poolside.
- [Supported models](https://docs.poolside.ai/get-started/supported-models.md): An overview of Poolside models, including modes and context windows.
- [Best practices](https://docs.poolside.ai/ide/best-practices.md): Learn how to get the most out of Poolside Assistant.
- [Code completion](https://docs.poolside.ai/ide/code-completion.md): Learn how to use and configure AI-powered code completion.
- [Commands and shortcuts reference](https://docs.poolside.ai/ide/commands.md): A list of Poolside slash commands, IDE commands, and keyboard shortcuts.
- [Install Poolside Assistant](https://docs.poolside.ai/ide/install.md): Install the Poolside Assistant extension in your IDE.
- [Poolside Assistant](https://docs.poolside.ai/ide/poolside-assistant.md): Learn about Poolside Assistant for autonomous, multi-step development tasks.
- [Troubleshooting](https://docs.poolside.ai/ide/troubleshooting.md): Fix common issues you may encounter while using Poolside Assistant in your IDE.
- [Acceptable Use Policy](https://docs.poolside.ai/legal/acceptable-use-policy.md)
- [Data Processing Agreement](https://docs.poolside.ai/legal/data-processing-agreement.md)
- [End User License Agreement](https://docs.poolside.ai/legal/end-user-license-agreement.md)
- [Privacy Policy](https://docs.poolside.ai/legal/privacy-policy.md)
- [Trust Center](https://docs.poolside.ai/legal/trust-center.md)
- [Managed agents](https://docs.poolside.ai/managed-agents.md): Create and manage reusable agent configurations in the Poolside Console.
- [MCP servers](https://docs.poolside.ai/mcp-servers.md): Configure external tools and services that agents can invoke at runtime.
- [AWS metering and billing](https://docs.poolside.ai/metrics/aws-billing.md): Subscribe to Poolside through AWS Marketplace and manage metering and billing.
- [Billing metrics](https://docs.poolside.ai/metrics/billing-metrics.md): Understand the fields in Poolside billing events.
- [Sharing metrics with Poolside](https://docs.poolside.ai/metrics/sharing-metrics.md): An overview of the metrics shared with Poolside for usage and billing tracking.
- [Usage metrics](https://docs.poolside.ai/metrics/usage-metrics.md): An overview of the available metrics.
- [Create chat completion](https://docs.poolside.ai/openai-api/chat/create-chat-completion.md): Generates a response based on a list of messages sent by the user to the model. The list of messages may include system messages, user messages, and assistant messages.<br/><br/>This endpoint allows other tools in the developer ecosystem to leverage poolside as a drop-in replacement for other models…
- [Create completion](https://docs.poolside.ai/openai-api/chat/create-completion.md): Get a completion along with the probabilities of alternative tokens at each position. This endpoint is not recommended for new use cases and is maintained for legacy compatibility only.<br/><br/>Use <i>/chat/completions</i> instead for the best and newest models.
- [List models](https://docs.poolside.ai/openai-api/models/list-models.md)
- [Identity Management API](https://docs.poolside.ai/organization/identity-management-api.md): Provision users and manage Poolside team membership programmatically.
- [Organization](https://docs.poolside.ai/organization/organization.md): Understand how authentication, authorization, and agent configuration work together to control access in your organization.
- [Permissions reference](https://docs.poolside.ai/organization/permissions-reference.md): A list of all role-based permissions available in Poolside.
- [Roles](https://docs.poolside.ai/organization/roles.md): Define and manage permissions using roles.
- [Teams](https://docs.poolside.ai/organization/teams.md): Create teams and assign roles to control how users access resources.
- [Users](https://docs.poolside.ai/organization/users.md): Add, manage, and remove users in your organization.
- [Plan mode](https://docs.poolside.ai/plan-mode.md): Use plan mode to review the agent's implementation approach before it changes your code.
- [Add team members](https://docs.poolside.ai/poolside-api/team/add-team-members.md): Adds new members to a team without affecting existing members. If a user is already a member of the team, they are skipped (idempotent operation).
- [List team members](https://docs.poolside.ai/poolside-api/team/list-team-members.md)
- [List teams](https://docs.poolside.ai/poolside-api/team/list-teams.md): Returns a paginated list of teams. Supports filtering by name (exact match via `name`) or by name prefix (via `name_prefix`).
- [Remove team members](https://docs.poolside.ai/poolside-api/team/remove-team-members.md): Removes the specified members from a team. If a user is not currently a member of the team, they are skipped (idempotent operation).
- [Set team members](https://docs.poolside.ai/poolside-api/team/set-team-members.md): Completely replaces the team's membership with an exact set of users. Members not in the provided list are removed from the team, and members in the list who aren't already on the team are added.
- [Create user](https://docs.poolside.ai/poolside-api/user/create-user.md)
- [Delete user](https://docs.poolside.ai/poolside-api/user/delete-user.md)
- [Get user](https://docs.poolside.ai/poolside-api/user/get-user.md)
- [List user teams](https://docs.poolside.ai/poolside-api/user/list-user-teams.md)
- [List users](https://docs.poolside.ai/poolside-api/user/list-users.md): Returns a paginated list of users matching the parameters.
- [Update user](https://docs.poolside.ai/poolside-api/user/update-user.md)
- [Poolside 1.20251025](https://docs.poolside.ai/release-notes/2025-10-25.md): Release notes for Poolside version 1.20251025.
- [Poolside 1.20260130](https://docs.poolside.ai/release-notes/2026-01-30.md): Release notes for Poolside version 1.20260130.
- [Poolside 2026.03.24](https://docs.poolside.ai/release-notes/2026-03-24.md): Release notes for Poolside version 2026.03.24.
- [Poolside 2026.04.27](https://docs.poolside.ai/release-notes/2026-04-27.md): Release notes for Poolside version 2026.04.27.
- [Laguna M.1 release notes](https://docs.poolside.ai/release-notes/laguna-m1.md): Release notes for the Laguna M.1 model.
- [Laguna XS.2 release notes](https://docs.poolside.ai/release-notes/laguna-xs2.md): Release notes for the Laguna XS.2 model.
- [Malibu 2.1 release notes](https://docs.poolside.ai/release-notes/malibu-2-1.md): Release notes for the Malibu 2.1 model.
- [Malibu 2.2 release notes](https://docs.poolside.ai/release-notes/malibu-2-2.md): Release notes for the Malibu 2.2 model.
- [Repositories](https://docs.poolside.ai/repositories.md): Connect code and storage sources that agents can use for skills and searchable reference content.
- [Example prompts](https://docs.poolside.ai/resources/example-prompts.md): Common development tasks and example prompts you can use with Poolside Assistant.
- [Example workflows](https://docs.poolside.ai/resources/example-workflows.md): Common tasks you can accomplish with Poolside Assistant using agent-driven workflows.
- [How agents work](https://docs.poolside.ai/resources/how-agents-work.md): A conceptual overview of agents powered by large language models, including their core components, behavior, and common use cases.
- [Prompting best practices](https://docs.poolside.ai/resources/prompting-best-practices.md): Learn how to write effective prompts to get the most out of Poolside.
- [Poolside In-Person Training Guide](https://docs.poolside.ai/resources/training.md): Guided user training.
- [Documenting code](https://docs.poolside.ai/resources/use-cases/documenting-code.md): This use case demonstrates how to use Poolside to generate, improve, and maintain code documentation. This can be especially useful when interacting with legacy codebases and understanding how existing codebases work.
- [Refactoring code](https://docs.poolside.ai/resources/use-cases/refactoring-code.md): This use case demonstrates how to use Poolside to refactor code by understanding existing implementations and suggesting improvements while maintaining functionality.
- [Visualizing data flows](https://docs.poolside.ai/resources/use-cases/visualizing-data-flows.md): This use case demonstrates how to use Poolside to generate visual representations of code structures, workflows, and architectures using Mermaid diagrams.
- [Sandboxes](https://docs.poolside.ai/sandboxes.md): Configure and manage sandbox environments for secure agent execution with network and resource controls.
- [Secrets](https://docs.poolside.ai/secrets.md): Store sensitive values like API keys and tokens that agents can use without exposing the raw value.
- [Skills](https://docs.poolside.ai/skills.md): Use skills to give agents reusable, task-specific instructions and resources.
- [Support Overview](https://docs.poolside.ai/support/overview.md): Overview of Poolside Standard Support, eligibility requirements, and options for non-standard deployments
- [Standard Support](https://docs.poolside.ai/support/standard-support.md): Learn about Poolside Standard Support, response times, scope, and more.
- [Tool permissions](https://docs.poolside.ai/tool-permissions.md): Control what Poolside agents can read, write, and run by using `settings.yaml`.
- [Trajectories](https://docs.poolside.ai/trajectories.md): Open and inspect an agent trajectory to understand how a session ran from start to finish.
- [Poolside Chat](https://docs.poolside.ai/web/poolside-chat.md): Use Poolside in your browser for chat-based development help, saved conversation history, and agent-backed workflows.

## OpenAPI Specs

- [openapi](https://api.poolsi.de/openai/openapi.json)