H2O.ai

H2O.ai Collections API

The Collections API from H2O.ai — 40 operation(s) for collections.

GitHub OpenAPI

Operations 56

POST /collections Create a Collection #
GET /collections List collections #
GET /collections/all Fetches all users' collection metadata sorted by last update time by default #
GET /collections/count Counts a number of collections #
GET /collections/{collection_id} Get a Collection #
DELETE /collections/{collection_id} Deletes collection #
PATCH /collections/{collection_id} Updates attributes of an existing collection #
GET /collections/{collection_id}/chunks/{chunk_ids} Returns specific chunks in a collection #
POST /collections/{collection_id}/chunks/match Finds chunks related to a message using semantic search #
POST /collections/{collection_id}/chunks/search Finds chunks related to a message using lexical search #
POST /collections/delete_job Creates a job to delete collections #
POST /collections/reset_all_collection_expirations Reset all collection expiry dates and inactivity intervals that have been set #
PUT /collections/{collection_id}/prompt_template Updates a prompt template reference of a collection #
DELETE /collections/{collection_id}/prompt_template Removes a prompt template reference from the collection #
PUT /collections/{collection_id}/expiry_date Updates an expiry date of a collection #
DELETE /collections/{collection_id}/expiry_date Removes an expiry date from a collection #
PUT /collections/{collection_id}/inactivity_interval Updates an inactivity interval of a collection #
DELETE /collections/{collection_id}/inactivity_interval Removes an inactivity interval from the collection #
PUT /collections/{collection_id}/workspace Updates the workspace associated with a collection #
POST /collections/{collection_id}/archive Archives a collection along with its associated data #
POST /collections/{collection_id}/unarchive Restores an archived collection to an active status #
PUT /collections/{collection_id}/size_limit Sets a maximum limit on the total size of documents (sum) added to a collection #
DELETE /collections/{collection_id}/size_limit Removes a size limit for a collection #
POST /collections/{collection_id}/is_public Updates a flag specifying whether a collection is private or public #
GET /collections/{collection_id}/settings Fetches collection settings #
PUT /collections/{collection_id}/settings Updates collection settings #
DELETE /collections/{collection_id}/prompt_settings Resets the prompt settings for a given collection #
GET /collections/{collection_id}/metadata Fetches collection metadata #
PUT /collections/{collection_id}/metadata Updates collection metadata #
PUT /collections/{collection_id}/thumbnail Updates collection thumbnail #
DELETE /collections/{collection_id}/thumbnail Deletes collection thumbnail #
PUT /collections/{collection_id}/thumbnail/job Creates a job to update collection thumbnail #
DELETE /collections/{collection_id}/thumbnail/job Creates a job to delete collection thumbnail #
GET /collections/{collection_id}/chat_settings Fetches collection chat settings #
PUT /collections/{collection_id}/chat_settings Updates collection chat settings #
GET /collections/{collection_id}/documents List a Collection's documents #
PUT /collections/{collection_id}/documents/{document_id} Import an already stored document to an existing collection #
DELETE /collections/{collection_id}/documents/{document_id} Removes the document from the collection #
POST /collections/{collection_id}/documents/insert_job Creates job to insert document to the collection #
POST /collections/{collection_id}/documents/delete_job Creates job to remove documents from the collection #
GET /collections/{collection_id}/documents/count Counts a number of documents in the collection #
GET /collections/{collection_id}/chats List chat sessions for a given collection #
GET /collections/{collection_id}/chats/count Counts a number of chat sessions with the collection #
GET /collections/{collection_id}/questions List suggested questions for a given collection #
GET /collections/{collection_id}/permissions Returns a list of access permissions for a given collection #
DELETE /collections/{collection_id}/permissions Removes sharing of a collection to all other users except the original owner #
GET /collections/{collection_id}/group_permissions Returns a list of group access permissions for a given collection #
GET /collections/{collection_id}/public_permissions Returns the public permissions for a given collection #
PUT /collections/{collection_id}/permissions/{username} Shares a collection to a user #
DELETE /collections/{collection_id}/permissions/{username} Removes sharing of a collection to a user #
PUT /collections/{collection_id}/group_permissions/{group_id} Shares a collection to a group #
DELETE /collections/{collection_id}/group_permissions/{group_id} Removes sharing of a collection to a user #
POST /collections/{collection_id}/import_collection_job Creates job to import collection to the collection #
GET /collections/{collection_id}/scheduled_connectors List scheduled connectors for a collection #
POST /collections/{collection_id}/migrate_scheduled_connectors Migrate scheduled connectors from another collection #
POST /collections/{collection_id}/migrate_chat_sessions_job Creates a job to migrate all chat sessions from one collection to another #

Documentation

📖
Documentation
https://docs.h2o.ai/enterprise-h2ogpte/
📖
APIReference
https://h2ogpte.genai.h2o.ai/swagger-ui/
📖
GettingStarted
https://docs.h2o.ai/enterprise-h2ogpte/get-started
📖
Authentication
https://docs.h2o.ai/enterprise-h2ogpte/guide/apis
📖
Documentation
https://docs.h2o.ai/mlops/
📖
APIReference
https://docs.h2o.ai/mlops/model-scoring/mlops-scoring-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/openapi/h2o-ai-collections-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-collection-settings-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-document-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-scheduled-connector-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-collection-update-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-collection-create-request-schema.json

Other Resources

🔗
ChangeLog
https://docs.h2o.ai/enterprise-h2ogpte/changelog

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/h2o-ai:h2o-ai-collections-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

h2o-ai-collections-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: h2oGPTe REST Collections API
  description: '# Overview


    Users can easily interact with the h2oGPTe API through its REST API, allowing HTTP requests from any programming language.'
  version: v1.0.0
servers:
- url: https://h2ogpte.genai.h2o.ai/api/v1
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/openapi/h2o-ai-collections-api-openapi.yml