Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
public
103
post
/persona
Create Persona
get
/persona/{persona_id}
Get Persona
delete
/persona/{persona_id}
Delete Persona
patch
/persona/{persona_id}
Update Persona
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
get
/tool/{tool_id}
Get Custom Tool
get
/tool/openapi
List Openapi Tools
get
/tool
List Tools
post
/admin/tool/custom/validate
Validate Tool
get
/admin/agents
Get Agents Admin Paginated
get
/agents
Get Agents Paginated
get
/admin/persona
List Personas Admin
patch
/admin/persona/{persona_id}/undelete
Undelete Persona
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
get
/chat/file/{file_id}
Fetch Chat File
get
/chat/get-chat-session/{session_id}
Get Chat Session
get
/chat/get-user-chat-sessions
Get User Chat Sessions
post
/chat/send-chat-message
Handle Send Chat Message
get
/chat/search
Search Chats
post
/chat/seed-chat-session
Seed Chat
post
/chat/stop-chat-session/{chat_session_id}
Stop Chat Session
put
/manage/connector/{connector_id}/credential/{credential_id}
Associate Credential To Connector
delete
/manage/connector/{connector_id}/credential/{credential_id}
Dissociate Credential From Connector
post
/manage/admin/connector/run-once
Connector Run Once
get
/manage/admin/connector
Get Connectors By Credential
post
/manage/admin/connector
Create Connector From Model
get
/manage/credential
List Credentials
post
/manage/credential
Create Credential From Model
post
/manage/credential/private-key
Create Credential With Private Key
post
/manage/admin/deletion-attempt
Create Deletion Attempt For Connector Id
delete
/manage/admin/connector/{connector_id}
Delete Connector By Id
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/{credential_id}
Update Credential Data
delete
/manage/admin/credential/{credential_id}
Delete Credential By Id Admin
delete
/manage/credential/force/{credential_id}
Force Delete Credential By Id
get
/manage/connector-status
Get Basic Connector Indexing Status
get
/manage/admin/cc-pair/{cc_pair_id}
Get Cc Pair Full Info
get
/manage/admin/cc-pair/{cc_pair_id}/index-attempts
Get Cc Pair Index Attempts
get
/manage/admin/cc-pair/{cc_pair_id}/errors
Get Cc Pair Indexing Errors
get
/manage/admin/similar-credentials/{source_type}
Get Cc Source Full Info
get
/manage/connector/{connector_id}
Get Connector By Id
post
/manage/admin/connector/indexing-status
Get Connector Indexing Status
get
/manage/admin/connector/status
Get Connector Status
get
/manage/connector
Get Connectors
get
/manage/admin/connector/failed-indexing-status
Get Currently Failed Indexing Status
get
/onyx-api/connector-docs/{cc_pair_id}
Get Docs By Connector Credential Pair
get
/manage/indexed-sources
Get Indexed Sources
get
/manage/admin/connector/{connector_id}/files
List Connector Files
get
/manage/admin/credential
List Credentials Admin
post
/manage/admin/cc-pair/{cc_pair_id}/prune
Prune Cc Pair
put
/manage/admin/credential/swap
Swap Credentials For Connector
put
/manage/admin/cc-pair/{cc_pair_id}/status
Update Cc Pair Status
post
/manage/admin/connector/{connector_id}/files/update
Update Connector Files
put
/manage/admin/credential/private-key/{credential_id}
Update Credential Private Key
post
/manage/admin/connector/file/upload
Upload Files Api
delete
/onyx-api/ingestion/{document_id}
Delete Ingestion Doc
get
/onyx-api/ingestion
Get Ingestion Docs
post
/onyx-api/ingestion
Upsert Ingestion Doc
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
/version
Get Version
get
/versions
Get Versions
get
/health
Healthcheck
post
/user/projects/create
Create Project
get
/user/projects/{project_id}
Get Project
delete
/user/projects/{project_id}
Delete Project
patch
/user/projects/{project_id}
Update Project
get
/user/projects/file/{file_id}
Get User File
delete
/user/projects/file/{file_id}
Delete User File
get
/user/projects/session/{chat_session_id}/files
Get Chat Session Project Files
get
/user/projects/files/{project_id}
Get Files In Project
get
/user/projects/{project_id}/details
Get Project Details
get
/user/projects/{project_id}/instructions
Get Project Instructions
post
/user/projects/{project_id}/instructions
Upsert Project Instructions
get
/user/projects/
Get Projects
post
/user/projects/file/statuses
Get User File Statuses
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
post
/user/projects/file/upload
Upload User Files
post
/web-search/open-urls
Execute Open Urls
post
/web-search/search
Execute Web Search
post
/web-search/search-lite
Execute Web Search Lite
patch
/manage/admin/activate-user
Activate User Api
put
/manage/admin/users
Bulk Invite Users
patch
/manage/admin/deactivate-user
Deactivate User Api
delete
/manage/admin/delete-user
Delete User
get
/auth/type
Get Auth Type
get
/get-user-role
Get User Role
get
/manage/users/accepted
List Accepted Users
get
/manage/users
List All Users
get
/users
List All Users Basic Info
get
/manage/users/invited
List Invited Users
patch
/manage/admin/remove-invited-user
Remove Invited User
patch
/manage/set-user-role
Set User Role
get
/me
Verify User Logged In
public
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Generate code
Get Version
get
/version
Request
Base URL
https://cloud.onyx.app/api
URL
https://cloud.onyx.app/api/version
Auth
none declared
Response
200
OK
Successful Response
Version
Response
required
backend_version
string
required
Changes
No recorded changes to this operation across all 1 revision of this API.