@mirego/forra-api / All Request Functions
All Request Functions
Complete collection of API request functions for Scout. This module exports all available API functions including authentication, configuration, file management, and more. Functions are also organized into namespaces (assistants, chat, conversations, projects) for better organization.
Functions
- addAssistantWebLink
- addConversationToProject
- addKnowledgeBaseLink
- addProjectMembers
- addSkillToAssistant
- addSkillToConversation
- applyCatalogAdoption
- associateSharedCustomFunctionWithAssistant
- attachKnowledgeBaseToAssistant
- browseKnowledgeSourceItems
- buildAiCodeBox
- bulkUpdateExternalServiceVisibility
- cancelWorkflowRun
- checkAppVersion
- checkAuth
- checkImageTransparency
- chunkDocument
- clearWorkflowDebug
- createAndAttachAssistantKnowledgeBase
- createApiToken
- createAssistantFromTemplate
- createAutomation
- createKnowledgeBase
- createMemory
- createProject
- createSkill
- createTeam
- createTenant
- decodeAccessToken
- deleteAssistantWebLink
- deleteAutomation
- deleteAutomationRun
- deleteDraftSkill
- deleteKnowledgeBase
- deleteKnowledgeBaseFile
- deleteKnowledgeBaseLink
- deleteMemory
- deleteNotification
- deleteNotificationEndpoint
- deleteProject
- deleteSkill
- deleteTeam
- deleteTenant
- detachKnowledgeBaseFromAssistant
- detectTenant
- exportBillingReconciliation
- exportInstanceCostSummary
- exportTenantInvoiceCsv
- externalLogout
- fetchAdminConfig
- fetchAllAutomationRuns
- fetchAllExternalServicesVisibility
- fetchApiToken
- fetchApiTokens
- fetchApiTokenScopes
- fetchAssistantKnowledgeBaseDocuments
- fetchAssistantKnowledgeBases
- fetchAssistantMemories
- fetchAssistantSkills
- fetchAssistantsUsingSkill
- fetchAssistantWebLinks
- fetchAuditLog
- fetchAutomation
- fetchAutomationRun
- fetchAutomationRuns
- fetchAutomations
- fetchBillingReconciliation
- fetchConversationSkills
- fetchCosts
- fetchCurrentUser
- fetchDraftSkills
- fetchExternalServicesWithStatus
- fetchFeatureCatalog
- fetchGroups
- fetchImage
- fetchInstanceAuditLogs
- fetchInstanceCostSummary
- fetchKnowledgeBaseDocuments
- fetchKnowledgeBases
- fetchKnowledgeSources
- fetchModelLibraryMetadata
- fetchNotificationPreferences
- fetchNotifications
- fetchProject
- fetchProjectConversations
- fetchProjectGroupMembers
- fetchProjects
- fetchSharedCustomFunctions
- fetchSignedUrl
- fetchSkill
- fetchSkillAvatarAllowedContentTypes
- fetchSkills
- fetchTeam
- fetchTeams
- fetchTenantAuditLogs
- fetchTenantConfig
- fetchTenantInvoiceDetails
- fetchTenants
- fetchTenantSpendingOverview
- fetchUnreadNotificationsCount
- fetchUsageStatistics
- fetchUsageSummary
- fetchUserCosts
- fetchUserCustomPrompt
- fetchUserMemories
- fetchUserPreferences
- fetchUsers
- fetchUsersAndGroups
- fetchUserStats
- generateTenantInvoice
- getCatalogPackage
- getFileTextContent
- getSignedUploadUrl
- improveAssistantPrompt
- installCatalogPackage
- listCatalogInstallations
- listCatalogPackages
- listProjectMembers
- listTemplates
- llmFilterDocuments
- login
- logout
- markAllNotificationsRead
- markNotificationRead
- playStreamingSpeechSynthesis
- playWorkflowDebug
- prepareExternalLogin
- refreshImpersonationSession
- registerNotificationEndpoint
- reindexKnowledgeBase
- removeConversationFromProject
- removeProjectMember
- removeSharedCustomFunctionFromAssistant
- removeSkillFromAssistant
- removeSkillFromConversation
- resetAllConfigResources
- resetConfigResource
- restartWorkflowDebug
- resumeWorkflowRun
- revokeApiToken
- rollbackInstanceAuditLog
- rollbackTenantAuditLog
- runAutomation
- runWorkflow
- scanCatalogAdoption
- searchKnowledgeSourceItems
- setTeamMembers
- setTeamOwners
- switchTenant
- syncGroups
- triggerAdminTask
- updateAdminConfig
- updateApiToken
- updateAssistantKnowledgeBase
- updateAutomation
- updateCatalogPackage
- updateKnowledgeBase
- updateKnowledgeBaseFile
- updateMemory
- updateNotificationPreferences
- updateProject
- updateSkill
- updateTeam
- updateTenant
- updateTenantConfig
- updateUserCustomPrompt
- updateUserPreferences
- uploadConversationFile
- uploadFile
- uploadKnowledgeBaseFile
- uploadSharedCustomFunction
- uploadSkillAvatar
- uploadTenantLogo
- validateAdminConfig
- validateCatalogInstall
Interfaces
- AddProjectMembersRequest
- AddProjectMembersResponse
- AdoptionManifestRequest
- AdoptionMatch
- AdoptionScanResponse
- ApiTokenExpiryPresetResponse
- ApiTokenScopeResponse
- ApiTokenScopesResponse
- ApiTokensResponse
- ApiTokensTokenResponse
- AssistantSkillResponse
- AssistantUsingSkillResponse
- BuildAiCodeBoxRequest
- BuildAiCodeBoxResponse
- BulkUpdateExternalServiceVisibilityRequest
- CatalogPackage
- CatalogPackageSummary
- ContractInformation
- ConversationSkillResponse
- CostDetail
- CostsResponse
- CreateApiTokenRequest
- CreateProjectRequest
- CreateSkillRequest
- CreateTeamBody
- CreateTenantRequest
- CurrentUser
- DraftSkillResponse
- ExportInstanceCostSummaryParams
- ExternalServiceRequirement
- ExternalServicesWithStatusResponse
- ExternalServiceVisibilityResponse
- ExternalServiceWithStatusResponse
- FailedProjectMember
- FeatureCatalogResponse
- FetchCostsParams
- FetchDraftSkillsParams
- GenerateTenantInvoiceResponse
- GetSignedUploadUrlRequest
- GroupChange
- InstalledEntity
- InstallPackageRequest
- InstallValidation
- InstanceCostSummaryMetadata
- InstanceCostSummaryModel
- InstanceCostSummaryProvider
- InstanceCostSummaryResponse
- Invoice
- KnowledgeBaseDocumentResponse
- MembershipChange
- MissingDependency
- ModelLibraryMetadata
- NotificationEndpointRequest
- NotificationEndpointResponse
- NotificationResponse
- PackageDependency
- PackageVariableSpec
- PackageVersion
- PrepareExternalLoginResponse
- ProjectMemberResponse
- ProjectResponse
- ReconciliationModelRow
- ReconciliationProviderRow
- ReconciliationSummaryResponse
- RemoveProjectMemberResponse
- RunWorkflowRequest
- SatisfiedDependency
- ServiceVisibilityUpdate
- SharedGroup
- SharedTeam
- SharedUser
- SignedUploadUrlResponse
- SignedUrlResponse
- SkillDetailResponse
- SkillSummaryResponse
- SkillUploadResponse
- SpecificUserLimit
- SyncGroupsRequest
- SyncGroupsResponse
- TeamPrincipalGroup
- TeamPrincipalsBody
- TeamPrincipalsResponse
- TeamPrincipalUser
- TeamResponse
- Tenant
- TenantApplicationConfig
- TenantConfig
- TenantCostSummary
- TenantInvoiceDetailsResponse
- TenantSpendingOverview
- TenantSpendingOverviewResponse
- TokenPayload
- UnreadNotificationsCountResponse
- UpdateApiTokenRequest
- UpdatePackageResponse
- UpdateProjectRequest
- UpdateSkillRequest
- UpdateTeamBody
- UpdateTenantConfigRequest
- UpdateTenantRequest
- UsageSummaryResponse
- UserLimits
- UserPreferences
- UserStats
- WorkflowDebugConversationResponse
- WorkflowDebugRunRequest
- WorkflowRunResponse
Type Aliases
- AddAssistantWebLinkRequest
- AddAssistantWebLinkResponse
- AddKnowledgeBaseLinkRequest
- AddKnowledgeBaseLinkResponse
- AdminAuditLogEntry
- AdminAuditLogsListResponse
- AdoptionStatus
- AssociationResponse
- AttachKnowledgeBaseRequest
- AutomationPayload
- AutomationPayloadType
- AutomationResponse
- AutomationRunResponse
- AutomationRunStatus
- BrowseKnowledgeSourceRequest
- CatalogPackageType
- CheckAppVersionResponse
- Chunk
- ChunkDocumentRequest
- ChunkMetadata
- ConfigResourceType
- CreateAndAttachAssistantKnowledgeBaseRequest
- CreateAssistantFromTemplateRequest
- CreateAssistantFromTemplateResponse
- CreateAutomationRequest
- CreateKnowledgeBaseRequest
- CreateMemoryRequest
- DependencyType
- DetectTenantRequest
- DetectTenantResponse
- DocumentChunks
- FetchAuditLogsParams
- FetchSkillAvatarAllowedContentTypesResponse
- GetFileTextContentRequest
- GetFileTextContentResponse
- GroupChangeType
- GroupPublicResponse
- ImproveAssistantPromptRequest
- ImprovePromptResponse
- KnowledgeBaseIndexationStatus
- KnowledgeBaseResponse
- KnowledgeBaseScope
- KnowledgeSourceBrowseItemResponse
- KnowledgeSourceBrowseResponse
- KnowledgeSourceResponse
- KnowledgeSourceSearchItemResponse
- KnowledgeSourceSearchResponse
- LinkRequest
- LlmFilterDocumentsRequest
- LlmFilterDocumentsResponse
- LocalizedString
- LoginProvider
- LoginRequest
- LoginResponse
- LogoutRequest
- LogoutResponse
- MembershipChangeType
- MemoryResponse
- ModelVisibilityRequest
- ModelVisibilityResponse
- ModelVisibilityType
- NotificationEndpointType
- NotificationEntityType
- NotificationEvent
- NotificationListFilter
- NotificationPreferencesResponse
- NotificationType
- NotificationUri
- ProjectMemberAddFailureReason
- ProjectRole
- SchedulesResponse
- SearchKnowledgeSourceRequest
- SharedCustomFunction
- SharedCustomFunctionUploadResponse
- SkillResponse
- SkillScope
- SkillType
- SkillUsableIn
- StreamSpeechSynthesisRequest
- SwitchTenantRequest
- TemplateCanvas
- TemplateResponse
- TextConversionResult
- UpdateAdminConfigRequest
- UpdateAdminConfigResponse
- UpdateAssistantKnowledgeBaseRequest
- UpdateAutomationRequest
- UpdateKnowledgeBaseFileRequest
- UpdateKnowledgeBaseFileResponse
- UpdateKnowledgeBaseRequest
- UpdateMemoryRequest
- UpdateNotificationPreferencesRequest
- UpdatePackageOutcome
- UpdateUserCustomPromptRequest
- UpdateUserPreferencesRequest
- UploadKnowledgeBaseFileRequest
- UploadKnowledgeBaseFileResponse
- UploadSkillAvatarRequest
- UploadSkillAvatarResponse
- UploadTenantLogoRequest
- UploadTenantLogoResponse
- UsageStatisticsResponse
- UserCustomPromptResponse
- UserOrGroupResponse
- UserPublicResponse
- ValidateAdminConfigRequest
- ValidateAdminConfigResponse
- ValidationWarning
Variables
Enumerations
Namespaces
- adminAuditLogs
- automations
- catalog
- Projects API
- Skills API
- teams
- templates
- tenantAdmin
- utils
- workflows
References
ActiveStreamResponse
Re-exports ActiveStreamResponse
addAssistantFavourite
Re-exports addAssistantFavourite
addFileToAssistant
Re-exports addFileToAssistant
AddFileToAssistantRequest
Re-exports AddFileToAssistantRequest
AllowedAvatarContentTypesResponse
Re-exports AllowedAvatarContentTypesResponse
AssistantCustomFunction
Re-exports AssistantCustomFunction
AssistantCustomFunctionsResponse
Re-exports AssistantCustomFunctionsResponse
AssistantDataItem
Re-exports AssistantDataItem
AssistantDataResponseItem
Re-exports AssistantDataResponseItem
AssistantFileResponse
Re-exports AssistantFileResponse
AssistantPublicResponse
Re-exports AssistantPublicResponse
AssistantResponse
Re-exports AssistantResponse
assistants
Renames and re-exports Assistants API
AssistantSearchResult
Re-exports AssistantSearchResult
AssistantType
Re-exports AssistantType
AssistantUserTokenRequest
Re-exports AssistantUserTokenRequest
AssistantUserTokenResponse
Re-exports AssistantUserTokenResponse
AvailableFunction
Re-exports AvailableFunction
buildAssistantSkill
Re-exports buildAssistantSkill
BuildAssistantSkillRequest
Re-exports BuildAssistantSkillRequest
cancelStream
Re-exports cancelStream
CanvasRequiredConsentService
Re-exports CanvasRequiredConsentService
chat
Renames and re-exports Chat API
chatCompletion
Re-exports chatCompletion
ChatCompletionRequest
Re-exports ChatCompletionRequest
ChatCompletionResponse
Re-exports ChatCompletionResponse
CodingAgentConfigExportTarget
Re-exports CodingAgentConfigExportTarget
ContentRetrievingStrategy
Re-exports ContentRetrievingStrategy
ConversationResponse
Re-exports ConversationResponse
conversations
Renames and re-exports Conversations API
ConversationSearchResult
Re-exports ConversationSearchResult
ConversationsResponse
Re-exports ConversationsResponse
ConversationsResponseMetadata
Re-exports ConversationsResponseMetadata
ConversationSummaryResponse
Re-exports ConversationSummaryResponse
createAssistant
Re-exports createAssistant
createAssistantData
Re-exports createAssistantData
CreateAssistantDataRequest
Re-exports CreateAssistantDataRequest
CreateAssistantDataResponse
Re-exports CreateAssistantDataResponse
CreateAssistantRequest
Re-exports CreateAssistantRequest
createConversation
Re-exports createConversation
CreateConversationRequest
Re-exports CreateConversationRequest
DefaultModel
Re-exports DefaultModel
DelegationRequest
Re-exports DelegationRequest
DelegationResponse
Re-exports DelegationResponse
deleteAssistant
Re-exports deleteAssistant
deleteAssistantData
Re-exports deleteAssistantData
deleteAssistantDataItem
Re-exports deleteAssistantDataItem
DeleteAssistantDataRequest
Re-exports DeleteAssistantDataRequest
DeleteAssistantDataResponse
Re-exports DeleteAssistantDataResponse
deleteAssistantFile
Re-exports deleteAssistantFile
DeleteAssistantFileRequest
Re-exports DeleteAssistantFileRequest
deleteConversation
Re-exports deleteConversation
deleteConversations
Re-exports deleteConversations
deployAssistantUi
Re-exports deployAssistantUi
disconnectMcpOauth
Re-exports disconnectMcpOauth
EditFileInformationRequest
Re-exports EditFileInformationRequest
EditFileInformationResponse
Re-exports EditFileInformationResponse
executeAssistantCustomFunction
Re-exports executeAssistantCustomFunction
fetchAssistant
Re-exports fetchAssistant
fetchAssistantAvatarAllowedContentTypes
Re-exports fetchAssistantAvatarAllowedContentTypes
fetchAssistantFiles
Re-exports fetchAssistantFiles
fetchAssistantFunctions
Re-exports fetchAssistantFunctions
fetchAssistantLinks
Re-exports fetchAssistantLinks
fetchAssistants
Re-exports fetchAssistants
fetchAssistantUserToken
Re-exports fetchAssistantUserToken
fetchAvailableFunctions
Re-exports fetchAvailableFunctions
fetchCanvasRequiredConsent
Re-exports fetchCanvasRequiredConsent
fetchChatModels
Re-exports fetchChatModels
fetchCodingAgentConfigExport
Re-exports fetchCodingAgentConfigExport
FetchCodingAgentConfigExportParams
Re-exports FetchCodingAgentConfigExportParams
fetchConversation
Re-exports fetchConversation
fetchConversations
Re-exports fetchConversations
fetchDefaultModel
Re-exports fetchDefaultModel
fetchDeletedAssistants
Re-exports fetchDeletedAssistants
fetchFavouriteAssistants
Re-exports fetchFavouriteAssistants
fetchImageModels
Re-exports fetchImageModels
fetchPublicAssistant
Re-exports fetchPublicAssistant
fetchSpeechModels
Re-exports fetchSpeechModels
fetchTranscriptionModels
Re-exports fetchTranscriptionModels
fetchVideoJobStatus
Re-exports fetchVideoJobStatus
fetchVideoModels
Re-exports fetchVideoModels
FileDeleteResponse
Re-exports FileDeleteResponse
FileUploadResponse
Re-exports FileUploadResponse
generateAssistantAvatar
Re-exports generateAssistantAvatar
GenerateAssistantAvatarRequest
Re-exports GenerateAssistantAvatarRequest
getActiveStream
Re-exports getActiveStream
getAssistantUserData
Re-exports getAssistantUserData
getMcpOauthStatus
Re-exports getMcpOauthStatus
LinkResponse
Re-exports LinkResponse
mapToConversationSummaryResponse
Re-exports mapToConversationSummaryResponse
McpOauthServerStatus
Re-exports McpOauthServerStatus
McpOauthStatusResponse
Re-exports McpOauthStatusResponse
patchAssistant
Re-exports patchAssistant
PatchAssistantRequest
Re-exports PatchAssistantRequest
permanentlyDeleteAssistant
Re-exports permanentlyDeleteAssistant
prepareMcpOauth
Re-exports prepareMcpOauth
queryAssistantData
Re-exports queryAssistantData
QueryAssistantDataResponse
Re-exports QueryAssistantDataResponse
reconnectToStream
Re-exports reconnectToStream
removeAssistantFavourite
Re-exports removeAssistantFavourite
reorderAssistantFavourites
Re-exports reorderAssistantFavourites
replaceConversationPayload
Re-exports replaceConversationPayload
ReplaceConversationPayloadRequest
Re-exports ReplaceConversationPayloadRequest
restoreAssistant
Re-exports restoreAssistant
search
Re-exports search
SearchResponse
Re-exports SearchResponse
SearchResult
Re-exports SearchResult
setAssistantUserData
Re-exports setAssistantUserData
streamConversationCompletion
Re-exports streamConversationCompletion
StreamConversationCompletionRequest
Re-exports StreamConversationCompletionRequest
streamStatelessChatCompletion
Re-exports streamStatelessChatCompletion
StreamStatelessChatCompletionRequest
Re-exports StreamStatelessChatCompletionRequest
updateAssistant
Re-exports updateAssistant
updateAssistantData
Re-exports updateAssistantData
UpdateAssistantDataRequest
Re-exports UpdateAssistantDataRequest
UpdateAssistantDataResponse
Re-exports UpdateAssistantDataResponse
UpdateAssistantRequest
Re-exports UpdateAssistantRequest
updateConversation
Re-exports updateConversation
updateConversationMessage
Re-exports updateConversationMessage
UpdateConversationMessageRequest
Re-exports UpdateConversationMessageRequest
UpdateConversationRequest
Re-exports UpdateConversationRequest
updateConversationUserData
Re-exports updateConversationUserData
updateConversationUserDataKey
Re-exports updateConversationUserDataKey
UpdateConversationUserDataRequest
Re-exports UpdateConversationUserDataRequest
updateFileInformation
Re-exports updateFileInformation
uploadAssistantAvatar
Re-exports uploadAssistantAvatar
UploadAssistantAvatarRequest
Re-exports UploadAssistantAvatarRequest
UploadAssistantAvatarResponse
Re-exports UploadAssistantAvatarResponse