How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
H2O.ai

H2O.ai Collections API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

H2O.ai Collections API is one of 26 APIs that H2O.ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Collection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and a changelog.

This API exposes 56 operations across 40 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version v1.0.0.

Requests are made against a single base URL, https://h2ogpte.genai.h2o.ai/api/v1.

56 operations 40 paths 28 schemas 12 DELETE17 GET1 PATCH13 POST13 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.0.0
Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

H2O.ai Collections API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Using an API key generated by H2OGPTe

Paths & Operations 56

Across 40 paths, the API surfaces 56 operations — 12 DELETE, 17 GET, 1 PATCH, 13 POST, 13 PUT. Each is listed below with its method, path, parameters, and response codes.

Collections 56
POST
/collections
Create a Collection
create_collection body → 201400401403404default
GET
/collections
List collections.
list_collections 7 params → 200400401default
GET
/collections/all
Fetches all users' collection metadata sorted by last update time by default.
list_all_collections 5 params → 200400401default
GET
/collections/count
Counts a number of collections.
get_collection_count → 200400401default
GET
/collections/{collection_id}
Get a Collection
get_collection 1 param → 200400401404default
DELETE
/collections/{collection_id}
Deletes collection.
delete_collection 2 params → 204400401default
PATCH
/collections/{collection_id}
Updates attributes of an existing collection.
update_collection 1 param body → 200400401404default
GET
/collections/{collection_id}/chunks/{chunk_ids}
Returns specific chunks in a collection.
get_collection_chunks 2 params → 200400401default
POST
/collections/{collection_id}/chunks/match
Finds chunks related to a message using semantic search.
match_collection_chunks 1 param body → 200400401default
POST
/collections/{collection_id}/chunks/search
Finds chunks related to a message using lexical search.
search_collection_chunks 1 param body → 200400401default
POST
/collections/delete_job
Creates a job to delete collections.
create_delete_collection_job body → 201400401default
POST
/collections/reset_all_collection_expirations
Reset all collection expiry dates and inactivity intervals that have been set.
reset_all_collection_expirations → 204400401409default
PUT
/collections/{collection_id}/prompt_template
Updates a prompt template reference of a collection.
update_collection_prompt_template 1 param body → 200400401404default
DELETE
/collections/{collection_id}/prompt_template
Removes a prompt template reference from the collection.
delete_collection_prompt_template 1 param → 200400401404default
PUT
/collections/{collection_id}/expiry_date
Updates an expiry date of a collection.
update_collection_expiry_date 1 param body → 204400401default
DELETE
/collections/{collection_id}/expiry_date
Removes an expiry date from a collection.
delete_collection_expiry_date 1 param → 204400401default
PUT
/collections/{collection_id}/inactivity_interval
Updates an inactivity interval of a collection.
update_collection_inactivity_interval 1 param body → 204400401default
DELETE
/collections/{collection_id}/inactivity_interval
Removes an inactivity interval from the collection.
delete_collection_inactivity_interval 1 param → 204400401default
PUT
/collections/{collection_id}/workspace
Updates the workspace associated with a collection.
update_collection_workspace 1 param body → 204400401default
POST
/collections/{collection_id}/archive
Archives a collection along with its associated data.
archive_collection 1 param → 204400401404default
POST
/collections/{collection_id}/unarchive
Restores an archived collection to an active status.
unarchive_collection 1 param → 204400401404default
PUT
/collections/{collection_id}/size_limit
Sets a maximum limit on the total size of documents (sum) added to a collection.
set_collection_size_limit 1 param body → 204400401default
DELETE
/collections/{collection_id}/size_limit
Removes a size limit for a collection.
remove_collection_size_limit 1 param → 204400401default
POST
/collections/{collection_id}/is_public
Updates a flag specifying whether a collection is private or public.
update_collection_privacy 1 param body → 204400401default
GET
/collections/{collection_id}/settings
Fetches collection settings.
get_collection_settings 1 param → 200400401404default
PUT
/collections/{collection_id}/settings
Updates collection settings.
update_collection_settings 1 param body → 204400401403default
DELETE
/collections/{collection_id}/prompt_settings
Resets the prompt settings for a given collection.
reset_collection_prompt_settings 1 param → 204400401409default
GET
/collections/{collection_id}/metadata
Fetches collection metadata.
get_collection_metadata 1 param → 200400401404default
PUT
/collections/{collection_id}/metadata
Updates collection metadata.
update_collection_metadata 1 param body → 204400401default
PUT
/collections/{collection_id}/thumbnail
Updates collection thumbnail.
update_collection_thumbnail 2 params body → 204400401413415default
DELETE
/collections/{collection_id}/thumbnail
Deletes collection thumbnail.
delete_collection_thumbnail 2 params → 204400401default
PUT
/collections/{collection_id}/thumbnail/job
Creates a job to update collection thumbnail.
create_update_collection_thumbnail_job 2 params body → 201400401413415default
DELETE
/collections/{collection_id}/thumbnail/job
Creates a job to delete collection thumbnail.
create_delete_collection_thumbnail_job 1 param → 201400401default
GET
/collections/{collection_id}/chat_settings
Fetches collection chat settings.
get_collection_chat_settings 1 param → 200400401404default
PUT
/collections/{collection_id}/chat_settings
Updates collection chat settings.
update_collection_chat_settings 1 param body → 204400401default
GET
/collections/{collection_id}/documents
List a Collection's documents
list_documents_for_collection 4 params → 200400401default
PUT
/collections/{collection_id}/documents/{document_id}
Import an already stored document to an existing collection.
insert_document_into_collection 13 params → 204400401default
DELETE
/collections/{collection_id}/documents/{document_id}
Removes the document from the collection.
delete_document_from_collection 3 params → 204400401default
POST
/collections/{collection_id}/documents/insert_job
Creates job to insert document to the collection.
create_insert_document_to_collection_job 12 params body → 201400401default
POST
/collections/{collection_id}/documents/delete_job
Creates job to remove documents from the collection.
create_delete_document_from_collection_job 1 param body → 201400401default
GET
/collections/{collection_id}/documents/count
Counts a number of documents in the collection.
get_document_count_for_collection 1 param → 200400401default
GET
/collections/{collection_id}/chats
List chat sessions for a given collection.
list_chat_sessions_for_collection 4 params → 200400401default
GET
/collections/{collection_id}/chats/count
Counts a number of chat sessions with the collection.
get_chat_session_count_for_collection 1 param → 200400401default
GET
/collections/{collection_id}/questions
List suggested questions for a given collection.
list_questions_for_collection 2 params → 200400401default
GET
/collections/{collection_id}/permissions
Returns a list of access permissions for a given collection.
get_collection_permissions 1 param → 200400401default
DELETE
/collections/{collection_id}/permissions
Removes sharing of a collection to all other users except the original owner.
unshare_collection_for_all 1 param → 204400401409default
GET
/collections/{collection_id}/group_permissions
Returns a list of group access permissions for a given collection.
get_collection_group_permissions 1 param → 200400401500default
GET
/collections/{collection_id}/public_permissions
Returns the public permissions for a given collection.
list_collection_public_permissions 1 param → 200400401default
PUT
/collections/{collection_id}/permissions/{username}
Shares a collection to a user.
share_collection 2 params body → 204400401409default
DELETE
/collections/{collection_id}/permissions/{username}
Removes sharing of a collection to a user.
unshare_collection 2 params → 204400401409default
PUT
/collections/{collection_id}/group_permissions/{group_id}
Shares a collection to a group.
share_collection_with_group 2 params body → 204400401409default
DELETE
/collections/{collection_id}/group_permissions/{group_id}
Removes sharing of a collection to a user.
unshare_collection_from_group 2 params → 204400401409default
POST
/collections/{collection_id}/import_collection_job
Creates job to import collection to the collection.
create_import_collection_to_collection_job 16 params body → 201400401default
GET
/collections/{collection_id}/scheduled_connectors
List scheduled connectors for a collection
list_scheduled_connectors_for_collection 1 param → 200400401404default
POST
/collections/{collection_id}/migrate_scheduled_connectors
Migrate scheduled connectors from another collection
migrate_scheduled_connectors_to_collection 1 param body → 201400401403default
POST
/collections/{collection_id}/migrate_chat_sessions_job
Creates a job to migrate all chat sessions from one collection to another.
create_migrate_collection_chat_sessions_job 2 params body → 201400401default

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are Collection (23 properties), GuardrailsSettings (21 properties), Document (18 properties), JobDetails (18 properties). Each schema is shown below with its type and property counts.

CollectionSettings
object
17 properties
SuggestedQuestion
object
1 property 1 required
DeleteCollectionsJobRequest
object
1 property 1 required
ChatSettings
object
6 properties
PromptTemplateChangeRequest
object
1 property 1 required
Chunk
object
5 properties 5 required
EndpointError
object
2 properties 2 required
Count
object
1 property 1 required
Collection
object
23 properties 13 required
TagFilter
object
Filter for document tags supporting inclusion and exclusion. Note: The exclude list takes priority over the include list. If a document has a tag that appears…
2 properties
ChatSession
object
9 properties 2 required
ChatCompletionSelfReflectionConfig
object
A map with self reflection settings: llmreflection (type=string, example=gpt-4-0613) promptreflection (type=string, example=\"\"\"Prompt:\\\\n%s\\\\n\"\"\"\\\\…
CollectionCreateRequest
object
8 properties 2 required
GroupSharePermission
object
2 properties 1 required
JobDetailsStatus
object
2 properties 2 required
GuardrailsSettings
object
21 properties
SharePermission
object
2 properties 1 required
JobDetails
object
18 properties 13 required
ChunkSearchResult
ShareCollectionRequest
object
1 property
Metadata
object
CollectionUpdateRequest
object
3 properties
ChatCompletionRequestLLMArgs
object
A map of arguments sent to LLM with query. temperature (type=double, default=0.0) - A value used to modulate the next token probabilities. 0 is the most determ…
DeleteDocumentsJobRequest
object
1 property 1 required
Document
object
18 properties 9 required
ChatCompletionRAGConfig
object
A map with arguments to control RAG (retrieval-augmented-generation) types.: ragtype (type=enum[auto, llmonly, rag, hyde1, hyde2, rag+, alldata]) RAG type opti…
MigrateCollectionChatSessionsJobRequest
object
1 property 1 required
ScheduledConnectorDetails
object
14 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

h2o-ai-collections-api-openapi.yml Raw ↑

Other APIs H2O.ai publishes across the network.

h2oGPTe MCP Server
AE Profile APIs.io
H2O.ai Admin Sessions API
AE Profile APIs.io
H2O.ai Agents API
AE Profile APIs.io
H2O.ai AI Assistants API
AE Profile APIs.io
H2O.ai API Keys API
AE Profile APIs.io
H2O.ai Chat API
AE Profile APIs.io
H2O.ai Configurations API
AE Profile APIs.io
H2O.ai Document Ingestion API
AE Profile APIs.io
H2O.ai Documents API
AE Profile APIs.io
H2O.ai Extractors API
AE Profile APIs.io
H2O.ai Forums API
AE Profile APIs.io
H2O.ai Graph RAG API
AE Profile APIs.io
#Collection
← Back to H APIs
API Details
ID
h2o-ai:h2o-ai-collections-api
Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Docs
https://docs.h2o.ai/enterprise-h2ogpte/rest-api
Provider
H2O.ai
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=h2o-ai-collections-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/h2o-ai-collections-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of H2O.ai Collections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.