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 AI Assistants API

The AI Assistants API from H2O.ai — 30 operation(s) for ai assistants.

H2O.ai AI Assistants 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 AI Assistant. 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 42 operations across 30 paths, and defines 26 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.

42 operations 30 paths 26 schemas 8 DELETE16 GET15 POST3 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 AI Assistants 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 42

Across 30 paths, the API surfaces 42 operations — 8 DELETE, 16 GET, 15 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

AI Assistants 42
POST
/ai_assistants
Create an AI assistant
create_ai_assistant body → 201401default
GET
/ai_assistants
List AI assistants
list_ai_assistants 4 params → 200401default
POST
/ai_assistants/generate_spec
Generate AI assistant spec from a prompt
generate_assistant_spec body → 200401default
GET
/ai_assistants/{assistant_id}
Get an AI assistant by ID
get_ai_assistant 1 param → 200401default
PUT
/ai_assistants/{assistant_id}
Update an AI assistant
update_ai_assistant 1 param body → 200401default
DELETE
/ai_assistants/{assistant_id}
Delete an AI assistant
delete_ai_assistant 2 params → 204401default
POST
/ai_assistants/{assistant_id}/pause
Pause an AI assistant
pause_ai_assistant 1 param → 204401default
POST
/ai_assistants/{assistant_id}/unpause
Unpause an AI assistant
unpause_ai_assistant 1 param → 204401default
POST
/ai_assistants/{assistant_id}/start
Start an AI assistant
start_ai_assistant 1 param → 204401default
POST
/ai_assistants/{assistant_id}/stop
Stop an AI assistant and cancel any running agent
stop_ai_assistant 1 param → 204401default
POST
/ai_assistants/{assistant_id}/wake
Manually trigger a wake cycle
wake_ai_assistant 1 param → 200401default
GET
/ai_assistants/{assistant_id}/events
List assistant wake/sleep events
list_ai_assistant_events 5 params → 200401default
GET
/ai_assistants/{assistant_id}/messages
List direct messages with an assistant
list_ai_assistant_messages 4 params → 200401default
POST
/ai_assistants/{assistant_id}/messages
Send a message to an AI assistant
send_ai_assistant_message 1 param body → 201401default
PUT
/ai_assistants/{assistant_id}/permissions/{username}
Share an AI assistant with a user
share_ai_assistant 2 params body → 204401default
DELETE
/ai_assistants/{assistant_id}/permissions/{username}
Unshare an AI assistant from a user
unshare_ai_assistant 2 params → 204401default
PUT
/ai_assistants/{assistant_id}/tool
Update custom tool definition
update_ai_assistant_tool 1 param body → 204401default
DELETE
/ai_assistants/{assistant_id}/tool
Reset tool to default definition
reset_ai_assistant_tool 1 param → 204401default
GET
/ai_assistants/{assistant_id}/forums
List connected forums
list_ai_assistant_forums 3 params → 200401default
POST
/ai_assistants/{assistant_id}/forums
Connect assistant to a forum
connect_ai_assistant_forum 1 param body → 204401default
DELETE
/ai_assistants/{assistant_id}/forums/{forum_id}
Disconnect assistant from a forum
disconnect_ai_assistant_forum 2 params → 204401default
GET
/ai_assistants/{assistant_id}/collections
List collections connected to an assistant
list_ai_assistant_collections 3 params → 200401default
POST
/ai_assistants/{assistant_id}/collections
Connect assistant to a collection
connect_ai_assistant_collection 1 param body → 204401default
DELETE
/ai_assistants/{assistant_id}/collections/{collection_id}
Disconnect assistant from a collection
disconnect_ai_assistant_collection 2 params → 204401default
GET
/ai_assistants/{assistant_id}/schedules
List connected scheduled tasks
list_ai_assistant_schedules 3 params → 200401default
POST
/ai_assistants/{assistant_id}/schedules
Connect a scheduled task as wake trigger
connect_ai_assistant_schedule 1 param body → 204401default
DELETE
/ai_assistants/{assistant_id}/schedules/{scheduled_task_id}
Disconnect a scheduled task
disconnect_ai_assistant_schedule 2 params → 204401default
GET
/ai_assistants/{assistant_id}/files
List files stored by an AI assistant
list_ai_assistant_files 3 params → 200401default
GET
/ai_assistants/{assistant_id}/files/{file_id}/content
Download an assistant file
download_ai_assistant_file 2 params → 200401404default
GET
/ai_assistants/{assistant_id}/search_forum_posts
Search forum posts by keyword
search_assistant_forum_posts 10 params → 200400401403default
GET
/ai_assistants/{assistant_id}/history/chat
Get the assistant's full chat history as formatted text
get_ai_assistant_chat_history 3 params → 200401404default
GET
/ai_assistants/{assistant_id}/history/events
Get the assistant's full event history as formatted text
get_ai_assistant_event_history 3 params → 200401404default
GET
/ai_assistants/{assistant_id}/permissions
List sharing permissions for an AI assistant
list_ai_assistant_permissions 1 param → 200401default
POST
/event_types
Create a custom event type
create_event_type body → 201401default
GET
/event_types
List custom event types
list_event_types 3 params → 200401default
GET
/event_types/{event_type_id}
Get a custom event type by ID
get_event_type 1 param → 200401default
DELETE
/event_types/{event_type_id}
Delete a custom event type
delete_event_type 1 param → 200401default
POST
/ai_assistants/{assistant_id}/event_subscriptions
Subscribe an assistant to a custom event type
subscribe_to_event_type 1 param body → 201401default
GET
/ai_assistants/{assistant_id}/event_subscriptions
List an assistant's event subscriptions
list_event_subscriptions 3 params → 200401default
DELETE
/ai_assistants/{assistant_id}/event_subscriptions/{event_type_id}
Unsubscribe an assistant from a custom event type
unsubscribe_from_event_type 2 params → 200401default
POST
/ai_assistants/{assistant_id}/emit_event
Emit a custom event
emit_custom_event 1 param body → 200401default
POST
/ai_assistants/{assistant_id}/send_to_assistant
Send a message to another assistant
send_inter_assistant_message 1 param body → 201401default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are AiAssistant (30 properties), AiAssistantCreateRequest (17 properties), AiAssistantUpdateRequest (16 properties), AiAssistantSpec (14 properties). Each schema is shown below with its type and property counts.

AiAssistantCollectionConnectRequest
object
2 properties 1 required
AiAssistantForumLink
object
11 properties
AiAssistantMessage
object
11 properties
InterAssistantMessageRequest
object
3 properties 2 required
AiAssistantToolRequest
object
1 property 1 required
ShareAiAssistantRequest
object
1 property
AiAssistantMessageRequest
object
1 property 1 required
EventSubscription
object
5 properties
AiAssistantSpec
object
LLM-generated assistant configuration spec.
14 properties 3 required
EventSubscriptionRequest
object
1 property 1 required
AiAssistantForumConnectRequest
object
2 properties 1 required
EmitEventResponse
object
2 properties
EndpointError
object
2 properties 2 required
AiAssistantFile
object
3 properties
AiAssistantCollectionLink
object
9 properties 5 required
AiAssistantPermission
object
3 properties
AiAssistantUpdateRequest
object
16 properties
AiAssistantCreateRequest
object
17 properties 2 required
AiAssistantEvent
object
8 properties
AiAssistantScheduleLink
object
12 properties
AiAssistant
object
30 properties
EventType
object
8 properties
InterAssistantMessage
object
7 properties
EventTypeCreateRequest
object
3 properties 1 required
AiAssistantScheduleConnectRequest
object
1 property 1 required
EmitEventRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

h2o-ai-ai-assistants-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 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 Extractors 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 AI Assistants 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.