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 Documents API

The Documents API from H2O.ai — 20 operation(s) for documents.

Documentation Provider Profile APIs.io OpenAPI GitHub

H2O.ai Documents 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 Documents. 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 23 operations across 20 paths, and defines 19 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.

23 operations 20 paths 19 schemas 3 DELETE15 GET1 PATCH3 POST1 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 Documents 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 23

Across 20 paths, the API surfaces 23 operations — 3 DELETE, 15 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 23
GET
/documents
List documents.
list_documents 9 params → 200400401default
GET
/documents/count
Counts a number of documents.
get_document_count 1 param → 200400401default
GET
/documents/{document_id}
Finds a document by id.
get_document 1 param → 200400401404default
DELETE
/documents/{document_id}
Deletes a document.
delete_document 2 params → 204400401default
PATCH
/documents/{document_id}
Updates attributes of an existing document.
update_document 1 param body → 200400401404default
GET
/documents/{document_id}/chunks
Returns all chunks for a specific document.
list_document_chunks 2 params → 200400401default
POST
/documents/process_job
Creates job to process document.
create_process_document_job body → 201400401default
POST
/documents/delete_job
Creates job to delete documents.
create_delete_document_job body → 201400401default
GET
/documents/{document_id}/collections
Lists collections for containing a given document.
list_collections_for_document 3 params → 200400401default
POST
/documents/{document_id}/tags
Assigns a tag to the document.
create_tag_on_document 1 param body → 201400401404default
DELETE
/documents/{document_id}/tags/{tag_name}
Removes a tag from a document.
delete_tag_from_document 2 params → 200400401default
GET
/documents/{document_id}/chats
List chat sessions for a given document.
list_chat_sessions_for_document 3 params → 200400401default
GET
/documents/{document_id}/chats/count
Counts a number of chat sessions with the document.
get_chat_session_count_for_document 1 param → 200400401default
GET
/documents/{document_id}/summaries
Fetches recent document summaries/extractions/transformations
list_document_summaries 3 params → 200400401default
DELETE
/documents/summaries/{summary_ids}
Deletes document summaries.
delete_document_summaries 1 param → 204400401default
GET
/documents/{document_id}/metadata
Fetches document metadata.
get_document_metadata 1 param → 200400401404default
PUT
/documents/{document_id}/metadata
Updates document metadata.
update_document_metadata 1 param body → 204400401default
GET
/documents/{document_id}/user_source_file
Fetches document user source file.
get_document_user_source_file 1 param → 200204400401404default
GET
/documents/{document_id}/page_ocr_model
Fetches document page ocr model.
get_document_page_ocr_model 1 param → 200204400401404default
GET
/documents/{document_id}/page_layout
Fetches document page layout.
get_document_page_layout 1 param → 200204400401404default
GET
/documents/{document_id}/internal_metadata
Fetches document internal metadata.
get_document_internal_metadata 1 param → 200204400401404default
GET
/documents/{document_id}/guardrails_settings
Fetches document guardrails settings.
get_document_guardrails_settings 1 param → 200204400401404default
GET
/document_summaries/{summary_id}
Fetches document summary.
get_document_summary 1 param → 200400401404default

Schemas 19

The contract defines 19 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.

DocumentSummary
object
7 properties 6 required
Dictionary
object
Chunk
object
5 properties 5 required
EndpointError
object
2 properties 2 required
Count
object
1 property 1 required
Collection
object
23 properties 13 required
ChatSession
object
9 properties 2 required
JobDetailsStatus
object
2 properties 2 required
ProcessDocumentJobRequest
object
17 properties 1 required
GuardrailsSettings
object
21 properties
JobDetails
object
18 properties 13 required
ChunkSearchResult
DocumentUpdateRequest
object
2 properties
TagCreateRequest
object
1 property 1 required
Metadata
object
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
Tag
object
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

h2o-ai-documents-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 Collections API
AE Profile APIs.io
H2O.ai Configurations API
AE Profile APIs.io
H2O.ai Document Ingestion 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
#Documents
← Back to H APIs
API Details
ID
h2o-ai:h2o-ai-documents-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-documents-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/h2o-ai-documents-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 Documents 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.