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 Document Ingestion API

The Document Ingestion API from H2O.ai — 21 operation(s) for document ingestion.

Documentation Provider Profile APIs.io OpenAPI GitHub

H2O.ai Document Ingestion 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 Document Ingestion. 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 21 operations across 21 paths, and defines 18 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.

21 operations 21 paths 18 schemas 20 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 Document Ingestion 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 21

Across 21 paths, the API surfaces 21 operations — 20 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Document Ingestion 21
PUT
/uploads
Uploads file to H2OGPTe instance
upload_file body → 200400401default
POST
/uploads/{upload_ids}/ingest
Ingest uploaded document
ingest_upload 15 params body → 204400401default
POST
/uploads/{upload_ids}/ingest/job
Creates a job to ingest uploaded document
create_ingest_upload_job 15 params body → 201400401default
POST
/ingest/file_system
Adds files from the local system into a collection.
ingest_from_file_system 11 params body → 204400401default
POST
/ingest/file_system/job
Creates a job to add files from the local system into a collection.
create_ingest_from_file_system_job 11 params body → 201400401default
POST
/ingest/plain_text
Adds plain text to a collection.
ingest_from_plain_text 6 params body → 204400401default
POST
/ingest/plain_text/job
Creates a job to add plain text to a collection.
create_ingest_from_plain_text_job 6 params body → 201400401default
POST
/ingest/website
Crawls and ingest a URL into a collection.
ingest_from_website 14 params body → 204400401default
POST
/ingest/website/job
Creates a job to crawl and ingest a URL into a collection.
create_ingest_from_website_job 14 params body → 201400401default
POST
/ingest/agent_only_to_standard
Converts files uploaded in "agentonly" ingest mode to PDF and parses them.
ingest_agent_only_to_standard 13 params → 204400401default
POST
/ingest/agent_only_to_standard/job
Creates a job to parse files uploaded in "agentonly" ingest mode.
create_ingest_agent_only_to_standard_job 13 params → 201400401default
POST
/ingest/s3
Adds files from the AWS S3 storage into a collection.
ingest_from_s3 11 params body → 204400401default
POST
/ingest/s3/job
Creates a job to add files from the AWS S3 storage into a collection.
create_ingest_from_s3_job 11 params body → 201400401default
POST
/ingest/gcs
Adds files from the Google Cloud Storage into a collection.
ingest_from_gcs 11 params body → 204400401default
POST
/ingest/gcs/job
Creates a job to add files from the Google Cloud Storage into a collection.
create_ingest_from_gcs_job 11 params body → 201400401default
POST
/ingest/azure_blob_storage
Adds files from the Azure Blob Storage into a collection.
ingest_from_azure_blob_storage 11 params body → 204400401default
POST
/ingest/azure_blob_storage/job
Creates a job to add files from the Azure Blob Storage into a collection.
create_ingest_from_azure_blob_storage_job 11 params body → 201400401default
POST
/ingest/sharepoint_online
Adds files from SharePoint Online into a collection.
ingest_from_sharepoint_online 11 params body → 204400401default
POST
/ingest/sharepoint_online/job
Creates a job to add files from SharePoint Online into a collection.
create_ingest_from_sharepoint_online_job 11 params body → 201400401default
POST
/ingest/confluence
Ingests confluence pages into collection.
ingest_from_confluence 11 params body → 204400401default
POST
/ingest/confluence/job
Creates a job to ingest confluence pages into collection.
create_ingest_from_confluence_job 11 params body → 201400401default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are JobDetails (18 properties), S3Credentials (7 properties), SharepointOnlineCredentials (7 properties), IngestFromConfluenceBody (5 properties). Each schema is shown below with its type and property counts.

IngestFromConfluenceBody
object
5 properties 3 required
UploadedFile
object
2 properties 2 required
IngestFromSharepointOnlineBody
object
3 properties 2 required
EndpointError
object
2 properties 2 required
IngestUploadBody
object
1 property
ConfluenceCredentials
object
The object with Confluence credentials.
2 properties 2 required
IngestFromGcsBody
object
3 properties 1 required
JobDetailsStatus
object
2 properties 2 required
AzureCredentials
object
The object with Azure credentials. If container is private, set either accountkey or sastoken.
2 properties
IngestFromFileSystemBody
object
2 properties 2 required
JobDetails
object
18 properties 13 required
SharepointOnlineCredentials
object
Credentials for SharePoint Online. Provide either the app-auth triple (tenantname + clientid + clientsecret) or the OAuth-user pair (userid + optional connecto…
7 properties
IngestFromWebsiteBody
object
1 property 1 required
IngestFromS3Body
object
4 properties 1 required
IngestFromAzureBlobStorageBody
object
5 properties 3 required
GCSCredentials
object
The object holding JSON key of Google Cloud service account. If the object is not provided, only public buckets will be accessible.
1 property 1 required
S3Credentials
object
The object with S3 credentials. If the object is not provided, only public buckets will be accessible. When useirsa is true, accesskeyid and secretaccesskey ar…
7 properties
SharepointIngestionEntry
object
A single SharePoint entry to ingest. entrytype determines which other fields are required: - "site": objectid is required. - "drive": driveid is required. - "d…
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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