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

H2O.ai Extractors API

The Extractors API from H2O.ai — 10 operation(s) for extractors.

H2O.ai Extractors 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 Extractors. 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 17 operations across 10 paths, and defines 11 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.

17 operations 10 paths 11 schemas 4 DELETE5 GET4 POST4 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 Extractors 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 17

Across 10 paths, the API surfaces 17 operations — 4 DELETE, 5 GET, 4 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Extractors 17
GET
/extractors/{extractor_id}/permissions
Returns a list of users having access to given extractor.
get_extractor_permissions 1 param → 200400401default
PUT
/extractors/{extractor_id}/permissions
Resets and shares an extractor to a new list of users.
reset_and_share_extractor 1 param body → 204400401409default
DELETE
/extractors/{extractor_id}/permissions
Removes sharing of an extractor to all other users except the original owner.
unshare_extractor_for_all 1 param → 204400401409default
GET
/extractors/{extractor_id}/group_permissions
Returns a list of group access permissions for a given extractor.
get_extractor_group_permissions 1 param → 200400401default
PUT
/extractors/{extractor_id}/group_permissions
Resets and shares an extractor to a new list of groups.
reset_and_share_extractor_with_groups 1 param body → 204400401409default
POST
/extractors/{extractor_id}/is_public
Updates a flag specifying whether an extractor is private or public.
update_extractor_privacy 1 param body → 204400401409default
PUT
/extractors/{extractor_id}/permissions/{username}
Shares an extractor to a user.
share_extractor 2 params → 204400401409default
DELETE
/extractors/{extractor_id}/permissions/{username}
Removes sharing of an extractor to a user.
unshare_extractor 2 params → 204400401409default
PUT
/extractors/{extractor_id}/group_permissions/{group_id}
Shares an extractor to a group.
share_extractor_with_group 2 params → 204400401409default
DELETE
/extractors/{extractor_id}/group_permissions/{group_id}
Removes sharing of an extractor from a group.
unshare_extractor_from_group 2 params → 204400401409default
GET
/extractors/{extractor_id}
Fetch an extractor by ID
get_extractor 1 param → 200400401404default
DELETE
/extractors/{extractor_id}
Deletes extractor.
delete_extractor 1 param → 204400401default
GET
/extractors
List extractors.
list_extractors 3 params → 200400401default
POST
/extractors
Creates extractor.
create_extractor body → 200400401403404default
POST
/extractors/{extractor_id}/run
Run an extractor on a collection, document, or uploaded files (synchronous)
run_extractor 4 params body → 200400401404default
POST
/extractors/{extractor_id}/job
Create a job to run an extractor on a collection or document
create_extractor_run_job 4 params → 201400401404default
GET
/extractors/{extractor_id}/results
Retrieve extraction results
list_extractor_results 4 params → 200400401404default

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are GuardrailsSettings (21 properties), JobDetails (18 properties), Extractor (17 properties), ExtractorCreateRequest (14 properties). Each schema is shown below with its type and property counts.

DocumentExtractionResult
object
5 properties 4 required
EndpointError
object
2 properties 2 required
ExtractorCreateRequest
object
14 properties 4 required
GroupSharePermission
object
2 properties 1 required
JobDetailsStatus
object
2 properties 2 required
GuardrailsSettings
object
21 properties
SharePermission
object
2 properties 1 required
ResetAndShareWithGroupsRequest
object
1 property 1 required
JobDetails
object
18 properties 13 required
Extractor
object
17 properties 5 required
ResetAndShareRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs H2O.ai publishes across the network.

h2oGPTe MCP Server
H2O.ai Admin Sessions API
H2O.ai Agents API
H2O.ai AI Assistants API
H2O.ai API Keys API
H2O.ai Chat API
H2O.ai Collections API
H2O.ai Configurations API
H2O.ai Document Ingestion API
H2O.ai Documents API
H2O.ai Forums API
H2O.ai Graph RAG API
Where this information came from

This is an independent, third-party profile of H2O.ai Extractors 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.