Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.poolside.ai/llms.txt

Use this file to discover all available pages before exploring further.

Overview

Use the Poolside Console to create and manage models centrally for your organization. After configuration, users can select a model in different contexts, such as managed agents or editor-based workflows, depending on the model type. You can:
  • Connect models to inference endpoints
  • Configure models used by agents
  • Set a default model for your organization
  • Reuse shared connection settings across multiple models with model providers

Manage models

Use the Models pages in the Poolside Console to review models in your organization by type. You can review each model’s name, provider, status, and age, then select a model to inspect its configuration, review usage data, test its connection, or make changes.
  • Use the Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models page to view and manage chat models, including agentic models, that managed agents can use.
  • Use the Code Completion > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-codecompletion-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6c9d3f22b509aea3a53b01defec05b6b Models page to view and manage models that generate inline and multi-line code suggestions in supported IDEs.

Connect a model

Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models.
  2. Click New Model.
  3. Enter a Model Name.
  4. Optional: Enter a Description.
  5. Model Provider defaults to OpenAI-compatible API (no provider). To use a configured provider instead, select it from the dropdown. The model inherits the provider’s base URL and custom headers. To create one first, see Create a model provider.
  6. Enter or confirm the Base URL for the model endpoint. If needed, include query parameters in the URL. For example, https://inference.provider.com/openai/v1/?api-version=2024-10-21.
  7. Optional: For Model Name Override, enter the model name to send in the inference request. Leave this field empty to use the model name entered above.
  8. Set the Context Length using the slider. This is the maximum number of tokens the model supports. You can find this value on the model’s documentation from the provider.
  9. Optional: Under Custom HTTP Headers, enter the header name and value. If the model does not use a provider, use this field to configure headers directly on the model, such as Authorization: Bearer <api-key>. Models that use a provider inherit the provider’s headers. For those models, use this field only to configure additional headers or override the provider configuration. To add additional headers, click Add HTTP header.
  10. Optional: To insert runtime values in a header, click the plus icon in the value field and choose a placeholder such as Request ID, Identity (E-Mail), or Tenant SSO ID.
  11. Optional: Select Automatically create a default agent associated with this model. The agent is created with the same name as the model. You can view and edit it on the Agents page, or skip this and create an agent manually later.
  12. Click Connect to Model. Poolside automatically tests the connection before saving.
Next steps

View model usage

On a model’s detail page, you can review usage data for that model over a selected date range. The usage view includes input and output token counts so you can compare how a model is used over time. Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models or Code Completion > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-codecompletion-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6c9d3f22b509aea3a53b01defec05b6b Models.
  2. Select the model you want to review.
  3. Select the date range you want to view.
  4. Review the usage data for input and output tokens for the selected period.

Test a model connection

You can test a model connection in real time to verify that Poolside can reach the endpoint and send a valid request for the selected model type. Depending on the model configuration, the test can include checks such as endpoint access, inference, and model-specific capabilities. Each check reports its result as it completes. If a check fails, the test returns a specific error message to help you diagnose the problem, such as a network issue or an authentication error. Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models or Code Completion > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-codecompletion-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6c9d3f22b509aea3a53b01defec05b6b Models.
  2. Select the model you want to test.
  3. Click Edit Model.
  4. On the model detail page, click Test Connection. The Testing Connection dialog opens.
  5. When the check is complete, click Close.

Set a default model

Set a default model to control which model Poolside uses when an agent or workflow does not explicitly specify one. Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models or Code Completion > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-codecompletion-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6c9d3f22b509aea3a53b01defec05b6b Models.
  2. Select the model you want to use as the default.
  3. Click Edit Model.
  4. On the model detail page, click the ellipsis () and select Set as default.
New agents and workflows use the default model unless another model is set in an agent or selected in the IDE.

Edit or delete a model

Deleting a model permanently removes it. If one or more agents use the model, Poolside lists those agents in the confirmation dialog and deletes them when you confirm the model deletion. Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models or Code Completion > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-codecompletion-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6c9d3f22b509aea3a53b01defec05b6b Models.
  2. Select the model you want to update or remove.
  3. Click Edit Model.
  4. To edit, make changes as needed, click Save Changes, and then click Test Connection to verify the connection.
  5. To delete, click the ellipsis () and select Delete.

Manage model providers

BETA Third-party model provider support is in beta. Poolside-managed models are supported. Compatibility with third-party models and providers may change without notice.
Use a model provider to store shared connection settings that multiple models can reuse. A provider defines settings such as a base API URL and custom HTTP headers, so you can configure them once instead of repeating the same connection details for each model.

Create a model provider

Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models.
  2. Select the Providers tab.
  3. Click New Model Provider.
  4. Enter a Provider Name.
  5. Enter the Base URL for the provider’s API. Poolside sends requests to this URL. If needed, include query parameters in the URL. For example, https://inference.provider.com/openai/v1/?api-version=2024-10-21.
  6. Optional: Upload a Provider Logo in PNG, JPEG, SVG, or WebP format (maximum 512 KB).
  7. Optional: Under Custom HTTP Headers, enter the header name and value for any headers required by the provider. For example, Authorization: Bearer <api-key>.
    • To insert runtime values in a header, click the + plus icon in the value field and choose a placeholder such as Request ID, Identity (E-Mail), or Tenant SSO ID.
    • To add additional headers, click Add HTTP header.
  8. Click Create.
Next steps

Edit or delete a provider

Deleting a provider removes the provider association from any models that use it. Those models remain available and keep the provider’s base URL as their endpoint URL, but they no longer inherit settings from the deleted provider. Prerequisites
  • You belong to a team with the tenant-admin role.
Steps
  1. In the Poolside Console, navigate to Agents > https://mintcdn.com/poolside/Tz6xG1rOCu6JtFws/images/icons/models-icon.svg?fit=max&auto=format&n=Tz6xG1rOCu6JtFws&q=85&s=6dc8b70fcfeca3d3a481d5644e7d722d Models.
  2. Select the Providers tab.
  3. Select the provider you want to update or remove.
  4. To edit, click Edit Provider, make changes as needed, and then click Save Changes.
  5. To delete, click Delete Provider.

Supported Chat model providers

Poolside connects to Chat models through any provider that exposes an OpenAI-compatible chat completions API. This section lists providers that have been tested with Poolside and their current compatibility status.

Tested providers

Although each of the providers below has been tested with a subset of models available, given the large number of possible model-provider combinations, not every model-provider combination may work as expected. The following providers are known to work with Poolside:

Known issues

The following providers have known compatibility issues. You may encounter unexpected behavior when using these providers with Poolside: