@mirego/forra-api / Assistants API
Assistants API
Functions for creating, managing, and deploying AI assistants. Assistants are customizable AI agents with specific instructions, knowledge bases, and capabilities. This module handles assistant configuration, file management, avatar customization, templating, and deployment options.
Functions
- addAssistantFavourite
- addFileToAssistant
- buildAssistantSkill
- createAssistant
- createAssistantData
- deleteAssistant
- deleteAssistantData
- deleteAssistantDataItem
- deleteAssistantFile
- deployAssistantUi
- disconnectMcpOauth
- executeAssistantCustomFunction
- fetchAssistant
- fetchAssistantAvatarAllowedContentTypes
- fetchAssistantFiles
- fetchAssistantFunctions
- fetchAssistantLinks
- fetchAssistants
- fetchAssistantUserToken
- fetchCanvasRequiredConsent
- fetchDeletedAssistants
- fetchFavouriteAssistants
- fetchPublicAssistant
- generateAssistantAvatar
- getAssistantUserData
- getMcpOauthStatus
- patchAssistant
- permanentlyDeleteAssistant
- prepareMcpOauth
- queryAssistantData
- removeAssistantFavourite
- reorderAssistantFavourites
- restoreAssistant
- setAssistantUserData
- updateAssistant
- updateAssistantData
- updateFileInformation
- uploadAssistantAvatar
Interfaces
- AssistantCustomFunction
- AssistantCustomFunctionsResponse
- BuildAssistantSkillRequest
- McpOauthServerStatus
- McpOauthStatusResponse
Type Aliases
- AddFileToAssistantRequest
- AllowedAvatarContentTypesResponse
- AssistantDataItem
- AssistantDataResponseItem
- AssistantFileResponse
- AssistantPublicResponse
- AssistantResponse
- AssistantUserTokenRequest
- AssistantUserTokenResponse
- CanvasRequiredConsentService
- ContentRetrievingStrategy
- CreateAssistantDataRequest
- CreateAssistantDataResponse
- CreateAssistantRequest
- DelegationRequest
- DelegationResponse
- DeleteAssistantDataRequest
- DeleteAssistantDataResponse
- DeleteAssistantFileRequest
- EditFileInformationRequest
- EditFileInformationResponse
- FileDeleteResponse
- FileUploadResponse
- GenerateAssistantAvatarRequest
- LinkResponse
- PatchAssistantRequest
- QueryAssistantDataResponse
- UpdateAssistantDataRequest
- UpdateAssistantDataResponse
- UpdateAssistantRequest
- UploadAssistantAvatarRequest
- UploadAssistantAvatarResponse