/
H2
h2o
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Admin Sessions
3
Agents
57
AI Assistants
42
get
/ai_assistants
List AI assistants.
post
/ai_assistants
Create an AI assistant.
post
/ai_assistants/generate_spec
Generate AI assistant spec from a prompt.
get
/ai_assistants/{assistant_id}
Get an AI assistant by ID.
put
/ai_assistants/{assistant_id}
Update an AI assistant.
delete
/ai_assistants/{assistant_id}
Delete an AI assistant.
post
/ai_assistants/{assistant_id}/pause
Pause an AI assistant.
post
/ai_assistants/{assistant_id}/unpause
Unpause an AI assistant.
post
/ai_assistants/{assistant_id}/start
Start an AI assistant.
post
/ai_assistants/{assistant_id}/stop
Stop an AI assistant and cancel any running agent.
post
/ai_assistants/{assistant_id}/wake
Manually trigger a wake cycle.
get
/ai_assistants/{assistant_id}/events
List assistant wake/sleep events.
get
/ai_assistants/{assistant_id}/messages
List direct messages with an assistant.
post
/ai_assistants/{assistant_id}/messages
Send a message to an AI assistant.
put
/ai_assistants/{assistant_id}/permissions/{username}
Share an AI assistant with a user.
delete
/ai_assistants/{assistant_id}/permissions/{username}
Unshare an AI assistant from a user.
put
/ai_assistants/{assistant_id}/tool
Update custom tool definition.
delete
/ai_assistants/{assistant_id}/tool
Reset tool to default definition.
get
/ai_assistants/{assistant_id}/forums
List connected forums.
post
/ai_assistants/{assistant_id}/forums
Connect assistant to a forum.
delete
/ai_assistants/{assistant_id}/forums/{forum_id}
Disconnect assistant from a forum.
get
/ai_assistants/{assistant_id}/collections
List collections connected to an assistant.
post
/ai_assistants/{assistant_id}/collections
Connect assistant to a collection.
delete
/ai_assistants/{assistant_id}/collections/{collection_id}
Disconnect assistant from a collection.
get
/ai_assistants/{assistant_id}/schedules
List connected scheduled tasks.
post
/ai_assistants/{assistant_id}/schedules
Connect a scheduled task as wake trigger.
delete
/ai_assistants/{assistant_id}/schedules/{scheduled_task_id}
Disconnect a scheduled task.
get
/ai_assistants/{assistant_id}/files
List files stored by an AI assistant.
get
/ai_assistants/{assistant_id}/files/{file_id}/content
Download an assistant file.
get
/ai_assistants/{assistant_id}/search_forum_posts
Search forum posts by keyword.
get
/ai_assistants/{assistant_id}/history/chat
Get the assistant's full chat history as formatted text.
get
/ai_assistants/{assistant_id}/history/events
Get the assistant's full event history as formatted text.
get
/ai_assistants/{assistant_id}/permissions
List sharing permissions for an AI assistant.
get
/event_types
List custom event types.
post
/event_types
Create a custom event type.
get
/event_types/{event_type_id}
Get a custom event type by ID.
delete
/event_types/{event_type_id}
Delete a custom event type.
get
/ai_assistants/{assistant_id}/event_subscriptions
List an assistant's event subscriptions.
post
/ai_assistants/{assistant_id}/event_subscriptions
Subscribe an assistant to a custom event type.
delete
/ai_assistants/{assistant_id}/event_subscriptions/{event_type_id}
Unsubscribe an assistant from a custom event type.
post
/ai_assistants/{assistant_id}/emit_event
Emit a custom event.
post
/ai_assistants/{assistant_id}/send_to_assistant
Send a message to another assistant.
API Keys
6
Chat
42
Collections
57
Configurations
12
Document Ingestion
21
Documents
24
Extractors
18
Forums
16
GraphRAG
7
Guardrails
4
Jobs
9
LLM Registry
8
Memory Blocks
15
Models
20
Permissions
34
Prompt Templates
19
Scheduled Tasks
16
Secrets
6
Shared Chats
6
Showcase
9
System
3
Tags
6
AI Assistants
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to List sharing permissions for an AI assistant.
get
/ai_assistants/{assistant_id}/permissions
Nov 6, 2026
a82a117320f4
Revision changes
info
endpoint added