/
ON
onyx-dot-app
/
Onyx API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2h ago · Updated 1mo ago
View markdown
onyx-dot-app
Onyx API
get
Get User Role
latest
OpenAPI 3.1.0
2026-07-17
104
173
304.0 KB
027af016ba5c
public
104
get
Get User Chat Sessions
get
Get Chat Session
post
Create New Chat Session
delete
Delete All Chat Sessions
delete
Delete Chat Session By Id
post
Handle Send Chat Message
post
Seed Chat
get
Fetch Chat File
get
Search Chats
post
Stop Chat Session
patch
Set User Role
get
List Accepted Users
get
List Invited Users
get
List All Users
put
Bulk Invite Users
patch
Remove Invited User
patch
Deactivate User Api
delete
Delete User
patch
Activate User Api
get
List All Users Basic Info
get
Get User Role
get
Verify User Logged In
post
Create Deletion Attempt For Connector Id
post
Upload Files Api
get
List Connector Files
post
Update Connector Files
get
Get Connectors By Credential
post
Create Connector From Model
get
Get Currently Failed Indexing Status
get
Get Connector Status
post
Get Connector Indexing Status
delete
Delete Connector By Id
patch
Update Connector From Model
post
Connector Run Once
get
Get Connectors
get
Get Indexed Sources
get
Get Connector By Id
get
Get Basic Connector Indexing Status
get
List Credentials Admin
get
Get Cc Source Full Info
put
Update Credential Data
delete
Delete Credential By Id Admin
put
Swap Credentials For Connector
get
List Credentials
post
Create Credential From Model
post
Create Credential With Private Key
get
Get Credential By Id
delete
Delete Credential By Id
patch
Update Credential From Model
put
Update Credential Private Key
delete
Force Delete Credential By Id
get
Get Cc Pair Index Attempts
get
Get Cc Pair Full Info
put
Update Cc Pair Status
post
Prune Cc Pair
get
Get Cc Pair Indexing Errors
put
Associate Credential To Connector
delete
Dissociate Credential From Connector
get
Get Projects
post
Create Project
post
Upload User Files
get
Get Project
delete
Delete Project
patch
Update Project
get
Get Files In Project
post
Link User File To Project
delete
Unlink User File From Project
get
Get Project Instructions
post
Upsert Project Instructions
get
Get Project Details
get
Get User File
delete
Delete User File
post
Get User File Statuses
get
Get Chat Session Project Files
post
Create Persona
get
Get Persona
delete
Delete Persona
patch
Update Persona
get
List Personas Admin
patch
Undelete Persona
get
Get Agents Paginated
get
Get Agents Admin Paginated
get
List Openapi Tools
get
Get Custom Tool
get
List Tools
post
Create Custom Tool
put
Update Custom Tool
delete
Delete Custom Tool
post
Validate Tool
get
Healthcheck
get
Get Auth Type
get
Get Version
get
Get Versions
get
Get Docs By Connector Credential Pair
get
Get Ingestion Docs
post
Upsert Ingestion Doc
delete
Delete Ingestion Doc
post
Execute Web Search
post
Execute Web Search Lite
post
Execute Open Urls
get
Get Global Token Limit Settings
post
Create Global Token Limit Settings
put
Update Token Limit Settings
delete
Delete Token Limit Settings
public
Get User Role
get
/get-user-role
Response
Successful Response
UserRoleResponse
required
role
string
required