@pipeshub-ai/sdk
v1.0.1
Published
<!-- Start Summary [summary] --> ## Summary
Readme
pipeshub-sdk-typescript
Summary
PipesHub API: Unified API documentation for PipesHub services.
PipesHub is an enterprise-grade platform providing:
- User authentication and management
- Document storage and version control
- Knowledge base management
- Enterprise search and conversational AI
- Third-party integrations via connectors
- System configuration management
- Crawling job scheduling
- Email services
Authentication
Most endpoints require JWT Bearer token authentication. Some internal endpoints use scoped tokens for service-to-service communication.
Base URLs
All endpoints use the /api/v1 prefix unless otherwise noted.
Table of Contents
SDK Installation
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
NPM
npm add @pipeshub-ai/sdkPNPM
pnpm add @pipeshub-ai/sdkBun
bun add @pipeshub-ai/sdkYarn
yarn add @pipeshub-ai/sdk[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.
Requirements
For supported JavaScript runtimes, please consult RUNTIMES.md.
SDK Example Usage
Example
import { Pipeshub } from "@pipeshub-ai/sdk";
const pipeshub = new Pipeshub();
async function run() {
const result = await pipeshub.userAccount.initAuth({
email: "[email protected]",
});
console.log(result);
}
run();
Authentication
Per-Client Security Schemes
This SDK supports the following security schemes globally:
| Name | Type | Scheme |
| ------------ | ------ | ------------ |
| bearerAuth | http | HTTP Bearer |
| oauth2 | oauth2 | OAuth2 token |
You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
import { Pipeshub } from "@pipeshub-ai/sdk";
const pipeshub = new Pipeshub({
security: {
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
},
});
async function run() {
const result = await pipeshub.userAccount.initAuth({
email: "[email protected]",
});
console.log(result);
}
run();
Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
import { Pipeshub } from "@pipeshub-ai/sdk";
const pipeshub = new Pipeshub();
async function run() {
const result = await pipeshub.userAccount.resetPasswordWithToken({
scopedToken: "<YOUR_BEARER_TOKEN_HERE>",
}, {
password: "H9GEHoL829GXj06",
});
console.log(result);
}
run();
Available Resources and Operations
AgentConversations
- listAgentConversations - List agent conversations
- createAgentConversation - Create agent conversation
- streamAgentConversation - Create agent conversation with streaming
- getAgentConversation - Get agent conversation
- deleteAgentConversation - Delete agent conversation
- addAgentMessage - Add message to agent conversation
- streamAgentMessage - Add message with streaming
- regenerateAgentAnswer - Regenerate agent response
AgentTemplates
- listAgentTemplates - List agent templates
- createAgentTemplate - Create agent template
- getAgentTemplate - Get agent template
- updateAgentTemplate - Update agent template
- deleteAgentTemplate - Delete agent template
Agents
- listAgents - List agents
- createAgent - Create agent
- listAgentTools - List available tools
- getAgent - Get agent
- updateAgent - Update agent
- deleteAgent - Delete agent
- getAgentPermissions - Get agent permissions
- updateAgentPermissions - Update agent permissions
- shareAgent - Share agent
- unshareAgent - Unshare an agent
AIModelsProviders
- getModelsByType - Get models by type
- getAvailableModelsByType - Get available models for selection
- addAIModelProvider - Add new AI model provider
- updateAIModelProvider - Update AI model provider
- deleteAIModelProvider - Delete AI model provider
- setDefaultAIModel - Set default AI model
AuthenticationConfiguration
- setAzureAdAuthConfig - Configure Azure AD authentication
- getAzureAdAuthConfig - Get Azure AD configuration
- setMicrosoftAuthConfig - Configure Microsoft authentication
- getMicrosoftAuthConfig - Get Microsoft authentication configuration
- setGoogleAuthConfig - Configure Google authentication
- getGoogleAuthConfig - Get Google authentication configuration
- setSsoAuthConfig - Configure SAML SSO authentication
- getSsoAuthConfig - Get SAML SSO configuration
- setOAuthConfig - Configure generic OAuth provider
- getGenericOAuthConfig - Get generic OAuth configuration
ConfigurationManager
- getSlackBotConfigs - Get Slack bot configurations
- createSlackBotConfig - Create Slack bot configuration
- updateSlackBotConfig - Update Slack bot configuration
- deleteSlackBotConfig - Delete Slack bot configuration
- setMetricsCollectionPushInterval - Set metrics push interval
- setMetricsCollectionRemoteServer - Set metrics remote server URL
- getAIModelsConfig - Get AI models configuration
- createAIModelsConfig - Create AI models configuration
- getAIModelsProviders - Get AI model providers
Connector
- reindexRecord - Reindex single record
- reindexRecordGroup - Reindex record group
- resyncConnector - Resync connector
- getConnectorStats - Get connector statistics
ConnectorConfiguration
- getConnectorConfig - Get connector configuration
- updateConnectorConfig - Update connector configuration
- updateConnectorAuthConfig - Update authentication configuration
- updateConnectorFiltersSyncConfig - Update filters and sync configuration
ConnectorControl
- toggleConnector - Toggle connector sync or agent
ConnectorFilters
- getConnectorFilters - Get filter options
- saveConnectorFilters - Save filter selections
- getFilterFieldOptions - Get dynamic filter options
ConnectorInstances
- listConnectorInstances - List connector instances
- createConnectorInstance - Create connector instance
- listActiveConnectors - List active connector instances
- listInactiveConnectors - List inactive connector instances
- listConfiguredConnectors - List configured connector instances
- listActiveAgentConnectors - List active agent connectors
- getConnectorInstance - Get connector instance
- deleteConnectorInstance - Delete connector instance
- updateConnectorName - Update connector instance name
ConnectorOAuth
- getOAuthAuthorizationUrl - Get OAuth authorization URL
- handleOAuthCallback - OAuth callback handler
- ~~getTokenFromCode~~ - Exchange Google authorization code for tokens :warning: Deprecated
ConnectorRegistry
- getConnectorRegistry - List available connector types
- getConnectorSchema - Get connector configuration schema
Conversations
- createConversation - Create a new AI conversation
- streamChat - Create conversation with streaming response
- getAllConversations - List all conversations
- getArchivedConversations - List archived conversations
- getConversationById - Get conversation by ID
- deleteConversationById - Delete conversation
- addMessage - Add message to conversation
- addMessageStream - Add message with streaming response
- shareConversation - Share conversation with users
- updateConversationTitle - Update conversation title
- archiveConversation - Archive conversation
- unarchiveConversation - Unarchive conversation
- regenerateAnswer - Regenerate AI response
- updateMessageFeedback - Submit feedback on AI response
- unshareConversationById - Unshare a conversation
CrawlingJobs
- scheduleCrawlingJob - Schedule a crawling job
- getCrawlingJobStatus - Get crawling job status
- removeCrawlingJob - Remove a crawling job
- getAllCrawlingJobStatus - Get all crawling job statuses
- removeAllCrawlingJob - Remove all crawling jobs
- pauseCrawlingJob - Pause a crawling job
- resumeCrawlingJob - Resume a crawling job
- getQueueStats - Get queue statistics
DocumentManagement
- downloadDocument - Download document
Folders
- createRootFolder - Create root folder
- getFolderContents - Get folder contents
- updateFolder - Update folder
- deleteFolder - Delete folder
- getFolderChildren - Get folder children (alias for folder contents)
- createSubfolder - Create subfolder
KnowledgeBases
- createKnowledgeBase - Create a new knowledge base
- listKnowledgeBases - List all knowledge bases
- getKnowledgeBase - Get knowledge base by ID
- updateKnowledgeBase - Update knowledge base
- deleteKnowledgeBase - Delete knowledge base
- reindexFailedRecords - Reindex failed records for connector
- moveRecord - Move record to another location
- getKnowledgeHubRootNodes - Get knowledge hub root nodes
- getKnowledgeHubChildNodes - Get knowledge hub child nodes
MetricsCollection
- getMetricsCollection - Get metrics collection configuration
- toggleMetricsCollection - Enable or disable metrics collection
OAuth
- exchangeOAuthCode - Exchange OAuth authorization code for tokens
OAuthApps
- listOAuthApps - List OAuth apps
- createOAuthApp - Create OAuth app
- listOAuthScopes - List available scopes
- getOAuthApp - Get OAuth app details
- updateOAuthApp - Update OAuth app
- deleteOAuthApp - Delete OAuth app
- regenerateOAuthAppSecret - Regenerate client secret
- suspendOAuthApp - Suspend OAuth app
- activateOAuthApp - Activate suspended OAuth app
- listOAuthAppTokens - List app tokens
- revokeAllOAuthAppTokens - Revoke all app tokens
OAuthConfiguration
- listToolsetOAuthConfigs - List OAuth configs by toolset type
- updateToolsetOAuthConfig - Update OAuth config
- deleteToolsetOAuthConfig - Delete OAuth config
- getOAuthRegistry - List OAuth-capable connector types
- getOAuthConnectorType - Get OAuth connector type details
- listOAuthConfigs - List OAuth configurations
- listOAuthConfigsByType - List OAuth configs for connector type
- createOAuthConfig - Create OAuth configuration
- getOAuthConfig - Get OAuth configuration
- updateOAuthConfig - Update OAuth configuration
- deleteOAuthConfig - Delete OAuth configuration
OAuthProvider
- oauthAuthorize - Initiate OAuth authorization flow
- oauthAuthorizeConsent - Submit authorization consent
- oauthToken - Exchange authorization code for tokens
- oauthRevoke - Revoke an access or refresh token
- oauthIntrospect - Introspect a token
OpenIDConnect
- oauthUserInfo - Get authenticated user information
- openidConfiguration - OpenID Connect Discovery
- jwks - JSON Web Key Set
OrganizationAuthConfig
- getAuthMethods - Get organization authentication methods
- updateAuthMethod - Update organization authentication methods
- setUpAuthConfig - Set up auth configuration
Organizations
- checkOrgExists - Check if organization exists
- createOrganization - Create organization
- getCurrentOrganization - Get current organization
- updateOrganization - Update organization
- deleteOrganization - Delete organization
- uploadOrganizationLogo - Upload organization logo
- getOrganizationLogo - Get organization logo
- deleteOrganizationLogo - Delete organization logo
- getOnboardingStatus - Get onboarding status
- updateOnboardingStatus - Update onboarding status
Permissions
- createKBPermission - Grant permissions
- listKBPermissions - List permissions
- updateKBPermissions - Update permissions
- deleteKBPermissions - Remove permissions
PlatformSettings
- setPlatformSettings - Update platform settings
- getPlatformSettings - Get platform settings
- getAvailableFeatureFlags - Get available feature flags
- setCustomSystemPrompt - Update custom system prompt
- getCustomSystemPrompt - Get custom system prompt
PublicURLs
- setFrontendPublicUrl - Set frontend public URL
- getFrontendPublicUrl - Get frontend public URL
- setConnectorPublicUrl - Set connector public URL
- getConnectorPublicUrl - Get connector public URL
Records
- getAllRecords - Get all records across knowledge bases
- getKBRecords - Get records for a knowledge base
- getKBChildren - Get KB children (alias for records)
- getRecordById - Get record by ID
- updateRecord - Update record
- deleteRecord - Delete record
- streamRecordBuffer - Stream record content
Saml
- signInViaSAML - Initiate SAML sign-in flow
- samlSignInCallback - SAML sign-in callback
SemanticSearch
- search - Perform semantic search
- searchHistory - Get search history
- deleteAllSearchHistory - Clear all search history
- getSearchById - Get search by ID
- deleteSearchById - Delete search by ID
- shareSearch - Share a search
- unshareSearch - Unshare a search
- archiveSearch - Archive a search
- unarchiveSearch - Unarchive a search
SMTPConfiguration
- createSMTPConfig - Create or update SMTP configuration
- getSMTPConfig - Get SMTP configuration
StorageConfiguration
- getStorageConfig - Get current storage configuration
Teams
- createTeam - Create a team
- listTeams - List teams
- getTeamById - Get team by ID
- updateTeam - Update team
- deleteTeam - Delete team
- getUserTeams - Get current user's teams
- getTeamUsers - Get users in team
- addUsersToTeam - Add users to team
- removeUserFromTeam - Remove user from team
- updateTeamUsersPermissions - Update team users permissions
- getUserCreatedTeams - Get user created teams
ToolsetConfiguration
- getToolsetConfig - Get toolset configuration
- ~~saveToolsetConfig~~ - Save toolset configuration :warning: Deprecated
- updateToolsetConfig - Update toolset configuration
- deleteToolsetConfig - Delete toolset configuration
ToolsetInstances
- createToolset - Create toolset instance
- listConfiguredToolsets - List configured toolsets
- checkToolsetStatus - Check toolset status
- reauthenticateToolset - Reauthenticate toolset
- getMyToolsets - List my toolsets with auth status
- getToolsetInstances - List toolset instances
- createToolsetInstance - Create toolset instance
- getToolsetInstance - Get toolset instance
- updateToolsetInstance - Update toolset instance
- deleteToolsetInstance - Delete toolset instance
- authenticateToolsetInstance - Authenticate toolset instance
- removeToolsetCredentials - Remove toolset credentials
- reauthenticateToolsetInstance - Mark instance for reauthentication
- getToolsetInstanceStatus - Get instance authentication status
ToolsetOAuth
- getToolsetOAuthUrl - Get OAuth authorization URL
- handleToolsetOAuthCallback - Handle OAuth callback
- getInstanceOAuthAuthorizationUrl - Get OAuth authorization URL for instance
ToolsetRegistry
- listToolsetRegistry - List available toolsets
- getToolsetSchema - Get toolset schema
Upload
- uploadRecordsToKB - Upload files to knowledge base
- uploadRecordsToFolder - Upload files to folder
- getUploadLimits - Get upload limits
UserAccount
- initAuth - Initialize authentication session
- authenticate - Authenticate user with credentials
- generateLoginOtp - Generate and send OTP for login
- forgotPassword - Request password reset email
- resetPasswordWithToken - Reset password with email token
- refreshToken - Refresh access token
- logout - Logout current session
- resetPassword - Reset password
UserGroups
- createUserGroup - Create user group
- getAllUserGroups - Get all user groups
- getUserGroupById - Get user group by ID
- updateUserGroup - Update user group
- deleteUserGroup - Delete user group
- addUsersToGroup - Add users to group
- removeUsersFromGroup - Remove users from group
- getGroupsForUser - Get groups for a user
- getUsersInGroup - Get users in group
- getGroupStatistics - Get group statistics
Users
- getAllUsers - Get all users
- createUser - Create a new user
- getUserById - Get user by ID
- updateUser - Update user
- deleteUser - Delete user
- getUserEmailById - Get user email by ID
- updateEmail - Update user email
- uploadUserDisplayPicture - Upload display picture
- getUserDisplayPicture - Get display picture
- removeUserDisplayPicture - Remove display picture
- bulkInviteUsers - Bulk invite users
- resendUserInvite - Resend user invite
- listUsersGraph - List users (paginated with graph data)
- unblockUser - Unblock a user in organization
- getAllUsersWithGroups - Get all users with groups
- getUsersByIds - Get users by IDs
- updateFullName - Update user full name
- updateFirstName - Update user first name
- updateLastName - Update user last name
- updateDesignation - Update user designation
- adminCheck - Check if user is admin
- getUserTeamsViaUsers - Get user teams
Standalone functions
All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.
To read more about standalone functions, check FUNCTIONS.md.
agentConversationsAddAgentMessage- Add message to agent conversationagentConversationsCreateAgentConversation- Create agent conversationagentConversationsDeleteAgentConversation- Delete agent conversationagentConversationsGetAgentConversation- Get agent conversationagentConversationsListAgentConversations- List agent conversationsagentConversationsRegenerateAgentAnswer- Regenerate agent responseagentConversationsStreamAgentConversation- Create agent conversation with streamingagentConversationsStreamAgentMessage- Add message with streamingagentsCreateAgent- Create agentagentsDeleteAgent- Delete agentagentsGetAgent- Get agentagentsGetAgentPermissions- Get agent permissionsagentsListAgents- List agentsagentsListAgentTools- List available toolsagentsShareAgent- Share agentagentsUnshareAgent- Unshare an agentagentsUpdateAgent- Update agentagentsUpdateAgentPermissions- Update agent permissionsagentTemplatesCreateAgentTemplate- Create agent templateagentTemplatesDeleteAgentTemplate- Delete agent templateagentTemplatesGetAgentTemplate- Get agent templateagentTemplatesListAgentTemplates- List agent templatesagentTemplatesUpdateAgentTemplate- Update agent templateaiModelsProvidersAddAIModelProvider- Add new AI model provideraiModelsProvidersDeleteAIModelProvider- Delete AI model provideraiModelsProvidersGetAvailableModelsByType- Get available models for selectionaiModelsProvidersGetModelsByType- Get models by typeaiModelsProvidersSetDefaultAIModel- Set default AI modelaiModelsProvidersUpdateAIModelProvider- Update AI model providerauthenticationConfigurationGetAzureAdAuthConfig- Get Azure AD configurationauthenticationConfigurationGetGenericOAuthConfig- Get generic OAuth configurationauthenticationConfigurationGetGoogleAuthConfig- Get Google authentication configurationauthenticationConfigurationGetMicrosoftAuthConfig- Get Microsoft authentication configurationauthenticationConfigurationGetSsoAuthConfig- Get SAML SSO configurationauthenticationConfigurationSetAzureAdAuthConfig- Configure Azure AD authenticationauthenticationConfigurationSetGoogleAuthConfig- Configure Google authenticationauthenticationConfigurationSetMicrosoftAuthConfig- Configure Microsoft authenticationauthenticationConfigurationSetOAuthConfig- Configure generic OAuth providerauthenticationConfigurationSetSsoAuthConfig- Configure SAML SSO authenticationconfigurationManagerCreateAIModelsConfig- Create AI models configurationconfigurationManagerCreateSlackBotConfig- Create Slack bot configurationconfigurationManagerDeleteSlackBotConfig- Delete Slack bot configurationconfigurationManagerGetAIModelsConfig- Get AI models configurationconfigurationManagerGetAIModelsProviders- Get AI model providersconfigurationManagerGetSlackBotConfigs- Get Slack bot configurationsconfigurationManagerSetMetricsCollectionPushInterval- Set metrics push intervalconfigurationManagerSetMetricsCollectionRemoteServer- Set metrics remote server URLconfigurationManagerUpdateSlackBotConfig- Update Slack bot configurationconnectorConfigurationGetConnectorConfig- Get connector configurationconnectorConfigurationUpdateConnectorAuthConfig- Update authentication configurationconnectorConfigurationUpdateConnectorConfig- Update connector configurationconnectorConfigurationUpdateConnectorFiltersSyncConfig- Update filters and sync configurationconnectorControlToggleConnector- Toggle connector sync or agentconnectorFiltersGetConnectorFilters- Get filter optionsconnectorFiltersGetFilterFieldOptions- Get dynamic filter optionsconnectorFiltersSaveConnectorFilters- Save filter selectionsconnectorGetConnectorStats- Get connector statisticsconnectorInstancesCreateConnectorInstance- Create connector instanceconnectorInstancesDeleteConnectorInstance- Delete connector instanceconnectorInstancesGetConnectorInstance- Get connector instanceconnectorInstancesListActiveAgentConnectors- List active agent connectorsconnectorInstancesListActiveConnectors- List active connector instancesconnectorInstancesListConfiguredConnectors- List configured connector instancesconnectorInstancesListConnectorInstances- List connector instancesconnectorInstancesListInactiveConnectors- List inactive connector instancesconnectorInstancesUpdateConnectorName- Update connector instance nameconnectorOAuthGetOAuthAuthorizationUrl- Get OAuth authorization URLconnectorOAuthHandleOAuthCallback- OAuth callback handlerconnectorRegistryGetConnectorRegistry- List available connector typesconnectorRegistryGetConnectorSchema- Get connector configuration schemaconnectorReindexRecord- Reindex single recordconnectorReindexRecordGroup- Reindex record groupconnectorResyncConnector- Resync connectorconversationsAddMessage- Add message to conversationconversationsAddMessageStream- Add message with streaming responseconversationsArchiveConversation- Archive conversationconversationsCreateConversation- Create a new AI conversationconversationsDeleteConversationById- Delete conversationconversationsGetAllConversations- List all conversationsconversationsGetArchivedConversations- List archived conversationsconversationsGetConversationById- Get conversation by IDconversationsRegenerateAnswer- Regenerate AI responseconversationsShareConversation- Share conversation with usersconversationsStreamChat- Create conversation with streaming responseconversationsUnarchiveConversation- Unarchive conversationconversationsUnshareConversationById- Unshare a conversationconversationsUpdateConversationTitle- Update conversation titleconversationsUpdateMessageFeedback- Submit feedback on AI responsecrawlingJobsGetAllCrawlingJobStatus- Get all crawling job statusescrawlingJobsGetCrawlingJobStatus- Get crawling job statuscrawlingJobsGetQueueStats- Get queue statisticscrawlingJobsPauseCrawlingJob- Pause a crawling jobcrawlingJobsRemoveAllCrawlingJob- Remove all crawling jobscrawlingJobsRemoveCrawlingJob- Remove a crawling jobcrawlingJobsResumeCrawlingJob- Resume a crawling jobcrawlingJobsScheduleCrawlingJob- Schedule a crawling jobdocumentManagementDownloadDocument- Download documentfoldersCreateRootFolder- Create root folderfoldersCreateSubfolder- Create subfolderfoldersDeleteFolder- Delete folderfoldersGetFolderChildren- Get folder children (alias for folder contents)foldersGetFolderContents- Get folder contentsfoldersUpdateFolder- Update folderknowledgeBasesCreateKnowledgeBase- Create a new knowledge baseknowledgeBasesDeleteKnowledgeBase- Delete knowledge baseknowledgeBasesGetKnowledgeBase- Get knowledge base by IDknowledgeBasesGetKnowledgeHubChildNodes- Get knowledge hub child nodesknowledgeBasesGetKnowledgeHubRootNodes- Get knowledge hub root nodesknowledgeBasesListKnowledgeBases- List all knowledge basesknowledgeBasesMoveRecord- Move record to another locationknowledgeBasesReindexFailedRecords- Reindex failed records for connectorknowledgeBasesUpdateKnowledgeBase- Update knowledge basemetricsCollectionGetMetricsCollection- Get metrics collection configurationmetricsCollectionToggleMetricsCollection- Enable or disable metrics collectionoAuthAppsActivateOAuthApp- Activate suspended OAuth appoAuthAppsCreateOAuthApp- Create OAuth appoAuthAppsDeleteOAuthApp- Delete OAuth appoAuthAppsGetOAuthApp- Get OAuth app detailsoAuthAppsListOAuthApps- List OAuth appsoAuthAppsListOAuthAppTokens- List app tokensoAuthAppsListOAuthScopes- List available scopesoAuthAppsRegenerateOAuthAppSecret- Regenerate client secretoAuthAppsRevokeAllOAuthAppTokens- Revoke all app tokensoAuthAppsSuspendOAuthApp- Suspend OAuth appoAuthAppsUpdateOAuthApp- Update OAuth appoAuthConfigurationCreateOAuthConfig- Create OAuth configurationoAuthConfigurationDeleteOAuthConfig- Delete OAuth configurationoAuthConfigurationDeleteToolsetOAuthConfig- Delete OAuth configoAuthConfigurationGetOAuthConfig- Get OAuth configurationoAuthConfigurationGetOAuthConnectorType- Get OAuth connector type detailsoAuthConfigurationGetOAuthRegistry- List OAuth-capable connector typesoAuthConfigurationListOAuthConfigs- List OAuth configurationsoAuthConfigurationListOAuthConfigsByType- List OAuth configs for connector typeoAuthConfigurationListToolsetOAuthConfigs- List OAuth configs by toolset typeoAuthConfigurationUpdateOAuthConfig- Update OAuth configurationoAuthConfigurationUpdateToolsetOAuthConfig- Update OAuth configoAuthExchangeOAuthCode- Exchange OAuth authorization code for tokensoAuthProviderOauthAuthorize- Initiate OAuth authorization flowoAuthProviderOauthAuthorizeConsent- Submit authorization consentoAuthProviderOauthIntrospect- Introspect a tokenoAuthProviderOauthRevoke- Revoke an access or refresh tokenoAuthProviderOauthToken- Exchange authorization code for tokensopenIDConnectJwks- JSON Web Key SetopenIDConnectOauthUserInfo- Get authenticated user informationopenIDConnectOpenidConfiguration- OpenID Connect DiscoveryorganizationAuthConfigGetAuthMethods- Get organization authentication methodsorganizationAuthConfigSetUpAuthConfig- Set up auth configurationorganizationAuthConfigUpdateAuthMethod- Update organization authentication methodsorganizationsCheckOrgExists- Check if organization existsorganizationsCreateOrganization- Create organizationorganizationsDeleteOrganization- Delete organizationorganizationsDeleteOrganizationLogo- Delete organization logoorganizationsGetCurrentOrganization- Get current organizationorganizationsGetOnboardingStatus- Get onboarding statusorganizationsGetOrganizationLogo- Get organization logoorganizationsUpdateOnboardingStatus- Update onboarding statusorganizationsUpdateOrganization- Update organizationorganizationsUploadOrganizationLogo- Upload organization logopermissionsCreateKBPermission- Grant permissionspermissionsDeleteKBPermissions- Remove permissionspermissionsListKBPermissions- List permissionspermissionsUpdateKBPermissions- Update permissionsplatformSettingsGetAvailableFeatureFlags- Get available feature flagsplatformSettingsGetCustomSystemPrompt- Get custom system promptplatformSettingsGetPlatformSettings- Get platform settingsplatformSettingsSetCustomSystemPrompt- Update custom system promptplatformSettingsSetPlatformSettings- Update platform settingspublicURLsGetConnectorPublicUrl- Get connector public URLpublicURLsGetFrontendPublicUrl- Get frontend public URLpublicURLsSetConnectorPublicUrl- Set connector public URLpublicURLsSetFrontendPublicUrl- Set frontend public URLrecordsDeleteRecord- Delete recordrecordsGetAllRecords- Get all records across knowledge basesrecordsGetKBChildren- Get KB children (alias for records)recordsGetKBRecords- Get records for a knowledge baserecordsGetRecordById- Get record by IDrecordsStreamRecordBuffer- Stream record contentrecordsUpdateRecord- Update recordsamlSAMLSignInCallback- SAML sign-in callbacksamlSignInViaSAML- Initiate SAML sign-in flowsemanticSearchArchiveSearch- Archive a searchsemanticSearchDeleteAllSearchHistory- Clear all search historysemanticSearchDeleteSearchById- Delete search by IDsemanticSearchGetSearchById- Get search by IDsemanticSearchSearch- Perform semantic searchsemanticSearchSearchHistory- Get search historysemanticSearchShareSearch- Share a searchsemanticSearchUnarchiveSearch- Unarchive a searchsemanticSearchUnshareSearch- Unshare a searchsmtpConfigurationCreateSMTPConfig- Create or update SMTP configurationsmtpConfigurationGetSMTPConfig- Get SMTP configurationstorageConfigurationGetStorageConfig- Get current storage configurationteamsAddUsersToTeam- Add users to teamteamsCreateTeam- Create a teamteamsDeleteTeam- Delete teamteamsGetTeamById- Get team by IDteamsGetTeamUsers- Get users in teamteamsGetUserCreatedTeams- Get user created teamsteamsGetUserTeams- Get current user's teamsteamsListTeams- List teamsteamsRemoveUserFromTeam- Remove user from teamteamsUpdateTeam- Update teamteamsUpdateTeamUsersPermissions- Update team users permissionstoolsetConfigurationDeleteToolsetConfig- Delete toolset configurationtoolsetConfigurationGetToolsetConfig- Get toolset configurationtoolsetConfigurationUpdateToolsetConfig- Update toolset configurationtoolsetInstancesAuthenticateToolsetInstance- Authenticate toolset instancetoolsetInstancesCheckToolsetStatus- Check toolset statustoolsetInstancesCreateToolset- Create toolset instancetoolsetInstancesCreateToolsetInstance- Create toolset instancetoolsetInstancesDeleteToolsetInstance- Delete toolset instancetoolsetInstancesGetMyToolsets- List my toolsets with auth statustoolsetInstancesGetToolsetInstance- Get toolset instancetoolsetInstancesGetToolsetInstances- List toolset instancestoolsetInstancesGetToolsetInstanceStatus- Get instance authentication statustoolsetInstancesListConfiguredToolsets- List configured toolsetstoolsetInstancesReauthenticateToolset- Reauthenticate toolsettoolsetInstancesReauthenticateToolsetInstance- Mark instance for reauthenticationtoolsetInstancesRemoveToolsetCredentials- Remove toolset credentialstoolsetInstancesUpdateToolsetInstance- Update toolset instancetoolsetOAuthGetInstanceOAuthAuthorizationUrl- Get OAuth authorization URL for instancetoolsetOAuthGetToolsetOAuthUrl- Get OAuth authorization URLtoolsetOAuthHandleToolsetOAuthCallback- Handle OAuth callbacktoolsetRegistryGetToolsetSchema- Get toolset schematoolsetRegistryListToolsetRegistry- List available toolsetsuploadGetUploadLimits- Get upload limitsuploadUploadRecordsToFolder- Upload files to folderuploadUploadRecordsToKB- Upload files to knowledge baseuserAccountAuthenticate- Authenticate user with credentialsuserAccountForgotPassword- Request password reset emailuserAccountGenerateLoginOtp- Generate and send OTP for loginuserAccountInitAuth- Initialize authentication sessionuserAccountLogout- Logout current sessionuserAccountRefreshToken- Refresh access tokenuserAccountResetPassword- Reset passworduserAccountResetPasswordWithToken- Reset password with email tokenuserGroupsAddUsersToGroup- Add users to groupuserGroupsCreateUserGroup- Create user groupuserGroupsDeleteUserGroup- Delete user groupuserGroupsGetAllUserGroups- Get all user groupsuserGroupsGetGroupsForUser- Get groups for a useruserGroupsGetGroupStatistics- Get group statisticsuserGroupsGetUserGroupById- Get user group by IDuserGroupsGetUsersInGroup- Get users in groupuserGroupsRemoveUsersFromGroup- Remove users from groupuserGroupsUpdateUserGroup- Update user groupusersAdminCheck- Check if user is adminusersBulkInviteUsers- Bulk invite usersusersCreateUser- Create a new userusersDeleteUser- Delete userusersGetAllUsers- Get all usersusersGetAllUsersWithGroups- Get all users with groupsusersGetUserById- Get user by IDusersGetUserDisplayPicture- Get display picture- [
usersGetUserEmailById](docs/sdks/users/README
