Skip to main content
Version: v1.7.3-14 🚧

API & SDKs

Enterprise h2oGPTe exposes its full feature set through a REST API, so you can automate workflows and build integrations in any language. This section introduces the API and the available SDKs, explains how they relate, and helps you pick the right entry point for your project.

Choosing an approach​

All these options talk to the same h2oGPTe REST API and authenticate with the same global API key. They differ in how much you write yourself:

  • Building in Python? Start with the Python Client Library. It's the fastest path and the most fully featured.
  • Working in another language, or want a typed client? Generate a REST API SDK (Python, JavaScript, or Go) from the OpenAPI specification.
  • Prefer raw HTTP, or exploring the API? Call the REST API directly by following the guide, or try endpoints live in the Swagger UI.
  • Already have an OpenAI-based app? Use the OpenAI-compatible endpoints documented on the SDKs page.

In this section​

h2oGPTe Python Client Library external
The official, fully featured Python client for Enterprise h2oGPTe. The quickest way to build collections, chats, and agent workflows in Python.
h2oGPTe REST API: SDKs
Generate Python, JavaScript, or Go client SDKs from the OpenAPI specification. Also covers the OpenAI-compatible endpoints and the custom tools and agents APIs.
h2oGPTe REST API: Guide
Call the REST API directly with raw HTTP requests, with no SDK required. Walk through a complete workflow: health check, collection, document ingestion, and agent queries.
h2oGPTe REST API: Interactive API docs (Swagger UI) external
Browse every REST endpoint and try live requests in your browser. The fastest way to explore the API surface and inspect request and response formats.

Next steps​

  • Create a global API key from the APIs page in the Guide. Every option here requires one.
  • Download the canonical OpenAPI specification (YAML) to generate clients or feed it to your own tooling.
Feedback