Skip to main content

​
Overview

The Poolside API provides programmatic access to Poolside’s AI capabilities, enabling you to integrate it into your applications and workflows. It is compatible with the OpenAI API specification.
  • Base URL: To make API requests, use the base URL configured for your deployment, for example: https://<your-api-domain>/
  • API schema: To view endpoint details and specifications, go to: https://<your-api-domain>/openai/docs#/

​
Key features

OpenAI-compatible API

Uses the same API specification as OpenAI, allowing seamless integration with existing tools and workflows.

Build custom automations and apps

Create custom automations, integrate Poolside into CI/CD pipelines, or build entirely new applications powered by Poolside’s AI models.

Simple to get started

Straightforward API key authentication and a familiar interface let you start making requests in minutes.

​
Getting started

To start using the Poolside API:
  1. Authenticate using API key-based authentication.
  2. Make your first request by following the examples.
  3. Explore advanced capabilities such as tools, streaming responses, and context-aware prompts.
  4. See the full API schema at https://<your-api-domain>/openai/docs#/.