/
ON
onyx-dot-app
Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
public
153
get
/chat/get-user-chat-sessions
Get User Chat Sessions
get
/chat/get-chat-session/{session_id}
Get Chat Session
post
/chat/create-chat-session
Create New Chat Session
delete
/chat/delete-all-chat-sessions
Delete All Chat Sessions
delete
/chat/delete-chat-session/{session_id}
Delete Chat Session By Id
post
/chat/end-incognito-session/{session_id}
End Incognito Session
post
/chat/send-chat-message
Handle Send Chat Message
get
/chat/file/{file_id}
Fetch Chat File
get
/chat/search
Search Chats
post
/chat/stop-chat-session/{chat_session_id}
Stop Chat Session
patch
/manage/admin/users/admin-access
Set User Admin Access Endpoint
get
/manage/users/accepted
List Accepted Users
get
/manage/users/accepted/all
List All Accepted Users
get
/manage/users/invited
List Invited Users
get
/manage/users
List All Users
put
/manage/admin/users
Bulk Invite Users
patch
/manage/admin/remove-invited-user
Remove Invited User
patch
/manage/admin/deactivate-user
Deactivate User Api
delete
/manage/admin/delete-user
Delete User
patch
/manage/admin/activate-user
Activate User Api
get
/users
List All Users Basic Info
get
/me/permissions
Get Current User Permissions
get
/me
Verify User Logged In
post
/manage/admin/deletion-attempt
Create Deletion Attempt For Connector Id
post
/manage/admin/connector/file/upload
Upload Files Api
get
/manage/admin/connector/{connector_id}/files
List Connector Files
post
/manage/admin/connector/{connector_id}/files/update
Update Connector Files
get
/manage/admin/connector
Get Connectors By Credential
post
/manage/admin/connector
Create Connector From Model
get
/manage/admin/connector/failed-indexing-status
Get Currently Failed Indexing Status
get
/manage/admin/connector/status
Get Connector Status
post
/manage/admin/connector/indexing-status
Get Connector Indexing Status
delete
/manage/admin/connector/{connector_id}
Delete Connector By Id
patch
/manage/admin/connector/{connector_id}
Update Connector From Model
post
/manage/admin/connector/run-once
Connector Run Once
get
/manage/connector
Get Connectors
get
/manage/indexed-sources
Get Indexed Sources
get
/manage/connector/{connector_id}
Get Connector By Id
get
/manage/connector-status
Get Basic Connector Indexing Status
get
/manage/admin/credential
List Credentials Admin
get
/manage/admin/similar-credentials/{source_type}
Get Cc Source Full Info
put
/manage/admin/credential/{credential_id}
Update Credential Data
delete
/manage/admin/credential/{credential_id}
Delete Credential By Id Admin
put
/manage/admin/credential/swap
Swap Credentials For Connector
get
/manage/credential
List Credentials
post
/manage/credential
Create Credential From Model
post
/manage/credential/private-key
Create Credential With Private Key
get
/manage/credential/{credential_id}
Get Credential By Id
delete
/manage/credential/{credential_id}
Delete Credential By Id
patch
/manage/credential/{credential_id}
Update Credential From Model
put
/manage/admin/credential/private-key/{credential_id}
Update Credential Private Key
put
/manage/admin/credential/{credential_id}/sharing
Update Credential Sharing Endpoint
delete
/manage/credential/force/{credential_id}
Force Delete Credential By Id
get
/manage/admin/cc-pair/{cc_pair_id}/index-attempts
Get Cc Pair Index Attempts
get
/manage/admin/cc-pair/{cc_pair_id}
Get Cc Pair Full Info
put
/manage/admin/cc-pair/{cc_pair_id}/status
Update Cc Pair Status
post
/manage/admin/cc-pair/{cc_pair_id}/prune
Prune Cc Pair
get
/manage/admin/cc-pair/{cc_pair_id}/errors
Get Cc Pair Indexing Errors
put
/manage/connector/{connector_id}/credential/{credential_id}
Associate Credential To Connector
delete
/manage/connector/{connector_id}/credential/{credential_id}
Dissociate Credential From Connector
get
/user/projects
Get Projects
post
/user/projects/create
Create Project
post
/user/projects/file/upload
Upload User Files
get
/user/projects/{project_id}
Get Project
delete
/user/projects/{project_id}
Delete Project
patch
/user/projects/{project_id}
Update Project
get
/user/projects/files/{project_id}
Get Files In Project
post
/user/projects/{project_id}/files/{file_id}
Link User File To Project
delete
/user/projects/{project_id}/files/{file_id}
Unlink User File From Project
get
/user/projects/{project_id}/instructions
Get Project Instructions
post
/user/projects/{project_id}/instructions
Upsert Project Instructions
get
/user/projects/{project_id}/details
Get Project Details
get
/user/projects/file/{file_id}
Get User File
delete
/user/projects/file/{file_id}
Delete User File
post
/user/projects/file/statuses
Get User File Statuses
get
/user/projects/session/{chat_session_id}/files
Get Chat Session Project Files
post
/search
Search
post
/persona
Create Persona
get
/persona/{persona_id}
Get Persona
delete
/persona/{persona_id}
Delete Persona
patch
/persona/{persona_id}
Update Persona
get
/admin/persona
List Personas Admin
patch
/admin/persona/{persona_id}/undelete
Undelete Persona
get
/agents
Get Agents Paginated
get
/admin/agents
Get Agents Admin Paginated
get
/tool/openapi
List Openapi Tools
get
/tool/{tool_id}
Get Custom Tool
patch
/tool/{tool_id}/preferences
Update Tool User Preferences
get
/tool
List Tools
post
/admin/tool/custom
Create Custom Tool
put
/admin/tool/custom/{tool_id}
Update Custom Tool
delete
/admin/tool/custom/{tool_id}
Delete Custom Tool
post
/admin/tool/custom/validate
Validate Tool
get
/health/ready
Readiness
get
/health
Healthcheck
get
/auth/type
Get Auth Type
get
/version
Get Version
get
/versions
Get Versions
get
/onyx-api/connector-docs/{cc_pair_id}
Get Docs By Connector Credential Pair
get
/onyx-api/ingestion
Get Ingestion Docs
post
/onyx-api/ingestion
Upsert Ingestion Doc
delete
/onyx-api/ingestion/{document_id}
Delete Ingestion Doc
post
/web-search/search
Execute Web Search
post
/web-search/search-lite
Execute Web Search Lite
post
/web-search/open-urls
Execute Open Urls
get
/admin/cost-overrides
List Cost Overrides
post
/admin/cost-overrides
Create Cost Override Endpoint
put
/admin/cost-overrides/{model_configuration_id}
Update Cost Override Endpoint
delete
/admin/cost-overrides/{model_configuration_id}
Delete Cost Override Endpoint
get
/user/usage
Get My Usage
get
/admin/usage/export
Export Usage
get
/admin/usage/system
Get System Usage
post
/admin/usage/reset
Reset Usage
get
/manage/admin/user-group
List User Groups
post
/manage/admin/user-group
Create User Group
get
/manage/admin/user-group/{user_group_id}
Get User Group
delete
/manage/admin/user-group/{user_group_id}
Delete User Group
patch
/manage/admin/user-group/{user_group_id}
Patch User Group
get
/manage/user-groups/minimal
List Minimal User Groups
get
/manage/admin/permissions/registry
Get Permission Registry
get
/manage/admin/user-group/{user_group_id}/permissions
Get User Group Permissions
put
/manage/admin/user-group/{user_group_id}/permissions
Set User Group Permissions
patch
/manage/admin/user-group/rename
Rename User Group Endpoint
patch
/manage/admin/user-group/{user_group_id}/incognito
Patch User Group Incognito
put
/manage/admin/user-group/{user_group_id}/data-access-cc-pairs
Set User Group Data Access Cc Pairs Endpoint
put
/manage/admin/user-group/{user_group_id}/managed-cc-pairs
Set Group Managed Cc Pairs
post
/manage/admin/user-group/{user_group_id}/add-users
Add Users
patch
/manage/admin/user-group/{user_group_id}/agents
Update Group Agents
patch
/manage/admin/user-group/{user_group_id}/document-sets
Update Group Document Sets
put
/manage/admin/user-group/{user_group_id}/manager
Set Group Manager
get
/analytics/admin/query
Get Query Analytics
get
/analytics/admin/user
Get User Analytics
get
/analytics/admin/onyxbot
Get Onyxbot Analytics
get
/analytics/admin/persona/messages
Get Persona Messages
get
/analytics/admin/persona/unique-users
Get Persona Unique Users
get
/analytics/assistant/{assistant_id}/stats
Get Assistant Stats
post
/admin/query-history/start-export
Start Query History Export
get
/admin/query-history/export-status
Get Query History Export Status
get
/admin/query-history/download
Download Query History Csv
post
/search/search-flow-classification
Search Flow Classification
post
/search/send-search-message
Handle Send Search Message
get
/search/search-history
Get Search History
get
/admin/token-rate-limits/global
Get Global Token Limit Settings
post
/admin/token-rate-limits/global
Create Global Token Limit Settings
put
/admin/token-rate-limits/rate-limit/{token_rate_limit_id}
Update Token Limit Settings
delete
/admin/token-rate-limits/rate-limit/{token_rate_limit_id}
Delete Token Limit Settings
get
/admin/token-rate-limits/user-groups
Get All Group Token Limit Settings
get
/admin/token-rate-limits/user-group/{group_id}
Get Group Token Limit Settings
post
/admin/token-rate-limits/user-group/{group_id}
Create Group Token Limit Settings
put
/admin/token-rate-limits/user-group/{group_id}/rate-limit/{rate_limit_id}
Update Group Token Limit Settings
delete
/admin/token-rate-limits/user-group/{group_id}/rate-limit/{rate_limit_id}
Delete Group Token Limit Settings
get
/admin/token-rate-limits/users
Get User Token Limit Settings
post
/admin/token-rate-limits/users
Create User Token Limit Settings
public
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Get User Analytics
get
/analytics/admin/user
Oct 28, 2026
76bc90bf55b6
Revision changes
info
endpoint added
Jan 6, 2026
2d941ea53eb3
Revision changes
breaking
api path removed without deprecation
Aug 21, 2025
9321c45d93b5
Revision changes
info
endpoint added