Tài liệu tham chiếu API
Sursa API công khai: 222 endpoint trong 35 phần. Phiên bản 1.62.0.
API công khai của Sursa dành cho các tích hợp xác thực bằng khóa API. Các thay đổi trong /v1 là thay đổi bổ sung: có thể xuất hiện thao tác mới, tham số tùy chọn, trường phản hồi và giá trị enum mới trong phản hồi, còn các client hiện có vẫn tiếp tục hoạt động. Hãy coi các giá trị enum chưa biết trong phản hồi là hợp lệ.
- URL gốc
- https://api.sursa.com
- Xác thực
- Gửi khóa API trong header Authorization: Authorization: Bearer <khóa>.
Các phần
Trạng thái và phiên bản dịch vụ
Đăng nhập, phiên, chế độ “View as” (Xem với tư cách), đổi và đặt lại mật khẩu, chấp nhận lời mời
Tài khoản người dùng của tổ chức
Khóa API của tổ chức
Ứng dụng OAuth của tổ chức và ủy quyền của nhân viên
Giao thức OAuth 2.0: màn hình xin quyền, cấp và thu hồi token, siêu dữ liệu của máy chủ ủy quyền
Nhật ký kiểm toán của tổ chức
Tổ chức, logo và xuất dữ liệu của tổ chức
Danh mục tài liệu
Bộ sưu tập tri thức
Thẻ tri thức: tải lên, nội dung, bảng, phiên bản, kiểm chứng, bình luận
Hàng đợi lập chỉ mục: tác vụ, xem trước kết quả đọc tệp, luồng thay đổi (SSE)
Cuộc trò chuyện với trợ lý
Tìm kiếm và câu trả lời của trợ lý, bao gồm luồng SSE
Yêu cầu truy cập vào nguồn của một câu trả lời bị ẩn
Nhật ký câu hỏi, gợi ý, xuất câu trả lời, câu trả lời động
Tệp xuất
Phân tích tri thức: tổng quan, trùng lặp, lỗ hổng tri thức và sức khỏe tri thức
Công việc của người dùng và của đội
Nguồn dữ liệu, chẳng hạn Google Drive và Confluence
Mô hình quyền truy cập: danh sách quyền và các quyền trên tổ chức, bộ sưu tập, thẻ và nguồn, cả quyền được gán trực tiếp lẫn quyền kế thừa
Vai trò: các tập quyền có tên, có sẵn và tùy chỉnh
Nhóm người dùng: nhóm thông thường, “All members” (Tất cả thành viên), nhóm theo vai trò và nhóm cá nhân
Thư mục của bộ sưu tập: cây sâu tối đa ba cấp, sắp xếp so với một phần tử cùng cấp, một thẻ trong nhiều thư mục, quyền kế thừa
Catalog dịch vụ bên ngoài (SaaS và nhà cung cấp) với tên, trang web, danh mục, biểu tượng và mô tả, cùng liên kết giữa các tên trong tổ chức của bạn với các mục của catalog
Bản nháp và phê duyệt xuất bản
Kiểm chứng: trạng thái, hạn kiểm chứng, người kiểm chứng, lịch sử, hàng đợi “kiểm chứng trước”, điểm tin cậy (Trust Score) và cho rời tổ chức
Thông báo bắt buộc đọc: đối tượng nhận, xác nhận đã đọc, báo cáo, nhắc nhở, xuất dữ liệu
Bình luận thẻ theo chuỗi, có điểm neo và trạng thái, cùng biểu tượng cảm xúc
Webhook của tổ chức: các webhook, đăng ký nhận sự kiện, chữ ký, lần gửi và thử lại
API công khai cho tích hợp: đặc tả máy đọc được của API này
Tải lên nhiều phần cho tệp lớn: phiên, các phần, hoàn tất kèm kiểm tra, và sử dụng cho thẻ, tệp lưu trữ nén hoặc lượt nhập
Phân tích sản phẩm: sự kiện sử dụng, bộ đếm theo đối tượng, bảng điều khiển sức khỏe, mức sử dụng và đóng góp, báo cáo gia hạn và xuất dữ liệu
Chất lượng câu trả lời: các câu hỏi chưa có câu trả lời tốt và các lỗ hổng tri thức đã được đưa vào xử lý
Tài liệu tài chính: tỷ giá và danh bạ đối tác giao dịch
Đối tượng
- AccessRequest
- AccessRequestDeny
- AccessRequestGrant
- AccessRequestList
- AccessRequestSource
- AccessRequestUser
- AccessRole
- AccessRoleCreate
- AccessRoleKind
- AccessRoleList
- AccessRoleScope
- AccessRoleUpdate
- Acl
- ActivityItem
- AnalyticsCardStats
- AnalyticsContribution
- AnalyticsHealth
- AnalyticsPeriod
- AnalyticsUsage
- Announcement
- AnnouncementAudience
- AnnouncementCreate
- AnnouncementList
- AnnouncementRecipient
- AnnouncementStats
- AnnouncementStatsSummary
- AnnouncementUsage
- AnswerAltPeriod
- AnswerAssignment
- AnswerBasis
- AnswerBasisCollection
- AnswerBasisCounted
- AnswerBasisExcluded
- AnswerBasisFlagged
- AnswerBasisScope
- AnswerCacheHit
- AnswerDataKind
- AnswerDrilldown
- AnswerEntity
- AnswerOutOfScope
- AnswerPeriod
- AnswerResponse
- AnswerSourceKind
- AnswerVerification
- AnswerVerificationItem
- AnswerWarning
- ApiKeyCreate
- ApiKeyCreated
- ApiKeyRoll
- ApiKeyRolled
- ApiKeyRow
- ApiKeyScope
- ApiKeyUpdate
- ApiLogEntry
- ApiLogList
- ApiUsage
- ApiUsagePoint
- ArchiveDocument
- ArchiveInfo
- ArchiveJob
- ArchiveSkip
- ArchiveSource
- ArchiveUploadForm
- ArchiveUploadFromUpload
- ArchiveUploadResult
- AskRequest
- Attachment
- AttachmentKind
- AuditActionCount
- AuditChainReport
- AuditEntry
- AuditExportRow
- BulkAction
- BulkRequest
- BulkResult
- BulkSkipped
- BulkSkipReason
- Calculation
- CalculationInput
- CallerApp
- CallerDataProfile
- CallerIdentity
- CallerKey
- CallerOrg
- CallerRateLimit
- CallerUser
- Card
- CardBrief
- CardBriefRow
- CardComment
- CardContent
- CardContentFile
- CardContentText
- CardCount
- CardDeleteResult
- CardEnrichmentStatus
- CardEvent
- CardExpanded
- CardExportFile
- CardFile
- CardFileUpsertForm
- CardFolderRef
- CardKind
- CardList
- CardPart
- CardSort
- CardStats
- CardStatsDay
- CardsXlsx
- CardTable
- CardTextContentType
- CardTextUpsert
- CardUpdate
- CardUploadForm
- CardUploadFromUpload
- CardUsage
- CardUsageEvent
- CardUsageItem
- CardUsageRow
- CardVerification
- CardVersion
- CardVersionDiff
- CatalogCategory
- CatalogResolveMatch
- CatalogResolveRequest
- CatalogResolveResponse
- CatalogService
- CategoryCount
- CategoryCreate
- CategoryDeleteResult
- CategoryProgress
- CategoryRef
- CategorySource
- CategoryUpdate
- CellType
- ChartReason
- ChartSpec
- ChartType
- ChatDone
- ChatErrorCode
- ChatEvent
- ChatEventData
- ChatEventError
- ChatEventFollowups
- ChatEventInterrupt
- ChatEventMeta
- ChatEventSources
- ChatEventStage
- ChatEventToken
- ChatEventTool
- ChatMessage
- ChatRequest
- ChatScope
- ChatScopePeriod
- ChatStage
- ChatStageInfo
- Collection
- CollectionDeleteResult
- CollectionExpanded
- CollectionHealth
- CollectionList
- CollectionRef
- CollectionReindex
- CollectionReindexResult
- CollectionRequest
- CollectionStats
- CollectionUpdate
- ColumnMeta
- ColumnRole
- CommentCreate
- CommentRequest
- CommentStatus
- CommentWithMentions
- ConfluenceSource
- ConnectorSource
- ContentJSON
- ContributionDay
- Contributor
- ConversationDetail
- ConversationList
- ConversationPublic
- DataProfileBrief
- Dataset
- DatasetCell
- DatasetColumn
- DatasetGroup
- DatasetRole
- DataSource
- DeletedResponse
- Delivery
- DiffHunk
- DiffLine
- DiffRow
- DocInvoiceExtraction
- DocInvoiceFields
- DocInvoiceLine
- DocInvoiceParty
- DocInvoiceTax
- DocKind
- DocumentCategory
- DocumentCategoryList
- DownloadFile
- Draft
- DraftCollaborator
- DraftCreate
- DraftList
- DraftScope
- DraftUpdate
- DraftWorkflowState
- DriveSource
- EditingLock
- EngineHealth
- EngineHealthLimited
- EngineLicenseSummary
- EntityAction
- EntityKind
- Error
- ErrorDetailObject
- ErrorInfo
- EventAccessRequest
- EventAccessRequestCreated
- EventAccessRequestResolved
- EventAnnouncement
- EventAnnouncementRead
- EventAnnouncementSent
- EventAPIKey
- EventApiKeyCreated
- EventApiKeyExpiring
- EventApiKeyRevoked
- EventAppAuthorized
- EventAppRevoked
- EventCard
- EventCardArchived
- EventCardCreated
- EventCardDeleted
- EventCardIndexed
- EventCardIndexFailed
- EventCardMoved
- EventCardPublished
- EventCardRestored
- EventCardUnverified
- EventCardUpdated
- EventCardVerified
- EventCollection
- EventCollectionCreated
- EventCollectionDeleted
- EventCollectionUpdated
- EventComment
- EventCommentCreated
- EventCommentResolved
- EventCreditsLow
- EventDraft
- EventDraftApproved
- EventDraftCreated
- EventDraftPublishRequested
- EventExportReady
- EventFile
- EventFolder
- EventFolderCreated
- EventFolderDeleted
- EventFolderUpdated
- EventGap
- EventGapDetected
- EventGroup
- EventGroupCreated
- EventGroupDeleted
- EventGroupMemberAdded
- EventGroupMemberRemoved
- EventGroupUpdated
- EventImportDocumentFailed
- EventImportSyncCompleted
- EventInvoice
- EventInvoiceIssued
- EventInvoicePaid
- EventJob
- EventJobCompleted
- EventJobFailed
- EventPlace
- EventQuestion
- EventQuestionAnswered
- EventQuestionFeedbackCreated
- EventQuestionUnanswered
- EventSource
- EventSourceConnectionLost
- EventSourceSyncCompleted
- EventSourceSyncFailed
- EventSubscription
- EventSubscriptionUpdated
- EventSync
- EventUser
- EventUserCreated
- EventUserDeactivated
- EventUserOffboarded
- EventUserUpdated
- EventVerification
- EventVerificationExpired
- EventVerificationRequested
- EventWebhookEndpointDisabled
- EventWebhookPing
- ExpandedUser
- ExportFile
- FeedbackRequest
- FeedItem
- FileAuthor
- FileAuthorList
- FileExpiry
- FileExtend
- FileList
- FileOrigin
- FilePreview
- FileRow
- FinanceCategoryRef
- FinanceCategorySource
- FinanceConversion
- FinanceConverted
- FinanceCurrencyMode
- FinanceDimension
- FinanceFilter
- FinanceInvoicePage
- FinanceInvoiceRow
- FinanceListRequest
- FinanceMeasure
- FinancePartyRef
- FinancePaymentPage
- FinancePaymentRow
- FinanceReport
- FinanceReportRequest
- FinanceReportRow
- FinanceReportTotal
- FinanceUnconverted
- Folder
- FolderCard
- FolderCardList
- FolderColor
- FolderCreate
- FolderDeleteResult
- FolderIcon
- FolderNode
- FolderPathItem
- FolderPosition
- FolderTree
- FolderTreeList
- FolderUpdate
- FolderWithPath
- Followup
- FollowupList
- GapCluster
- GapFollowup
- GapFollowupCreate
- GapFollowupPatch
- GapsResponse
- GrantLevel
- GrantObject
- GrantObjectType
- GrantRole
- GrantSubject
- Group
- GroupActivity
- GroupCreate
- GroupDetail
- GroupKind
- GroupList
- GroupManagedBy
- GroupMember
- GroupUpdate
- GuardrailVerdict
- HealthFull
- HealthLimited
- HealthPublic
- HealthServices
- HealthServiceState
- IndexUpgradeResult
- InvoiceDirection
- Job
- JobActionResult
- JobExpanded
- JobsBatch
- JobsResponse
- JobsSummary
- JobStatus
- JobStreamError
- JobStreamEvent
- JobStreamJob
- JobStreamSnapshot
- JobStreamSummary
- JobWithCard
- LoginChoice
- MePermissions
- Metadata
- MetadataPatch
- Notification
- NotificationKind
- NumberProvenance
- OAuthApp
- OAuthAppCreate
- OAuthAppList
- OAuthAppUpdate
- OAuthAppWithSecret
- OAuthAuthorization
- OAuthAuthorizationList
- OAuthClientType
- OAuthErrorResponse
- OAuthRevokeRequest
- OAuthScope
- OAuthServerMetadata
- OAuthTokenRequest
- OAuthTokenResponse
- ObjectGrant
- ObjectGrantRequest
- ObjectPermissionList
- ObjectPermissions
- OffboardRequest
- OffboardResult
- OrgInfo
- OrgLimits
- OrgLogoInfo
- OrgStatus
- OrgUsage
- OrgUsageView
- PaymentDirection
- PendingAction
- PendingActionResult
- PendingActionStatus
- Permission
- PermissionArea
- PermissionList
- ProvenanceKind
- ProvenanceMatch
- ProvenancePart
- PushDocument
- PushDocumentBatch
- PushDocumentBatchResult
- PushDocumentReason
- PushDocumentResult
- PushDocumentStatus
- PushDocumentStatusExpanded
- PushDocumentStatusList
- PushDocumentStatusValue
- PushPermissions
- PushSourceInfo
- PushSyncClose
- PushSyncOpen
- PushTouch
- PushTouchResult
- PushVerifiers
- QuestionFeedbackFilter
- QuestionFeedbackResult
- QuestionLogList
- QuestionLogRow
- QuestionPayload
- QuestionRow
- QuestionsCsv
- QuestionSource
- QuestionSourceSlim
- QueueStats
- ReactionDetail
- RefreshChange
- RefreshResult
- ReindexCounts
- ReindexPlan
- ReindexResult
- ReindexSkipped
- RestrictedInfo
- ReviewWarning
- Role
- SaveCardRequest
- SaveCardResult
- SearchHit
- SearchRequest
- SearchResponse
- ServiceRef
- SimilarItem
- SimilarResponse
- Source
- SourceCreate
- SourceItemCounts
- SourceKind
- SourceObjectType
- SourcePushKey
- SourcePushKeyCreate
- SourcePushKeyIssued
- SourcePushKeyList
- SourcePushSync
- SourcePushSyncList
- SourceRun
- SourceRunning
- SourceRunStatus
- SourceSettingsUpdate
- SourceStats
- SourceStatus
- SourceTrigger
- SourceUpdate
- SpendCategory
- SpendGroup
- SpendTaxonomy
- StatusOk
- StatusRevoked
- TableDiffItem
- TableProfile
- TableQuery
- TableRow
- TableRows
- TagList
- TaskScope
- TasksDetail
- TasksLegacy
- TextCardRequest
- TextCardResult
- Thread
- ThreadList
- ThreadUpdate
- Timings
- ToolCallInfo
- ToolName
- TrustParts
- TrustPoint
- TrustScore
- TurnVersions
- UnfinishedTurn
- UnverifyRequest
- Upload
- UploadComplete
- UploadCreate
- UploadPart
- UploadPartRef
- UploadPurpose
- UploadResult
- UploadStatus
- UsageDay
- UsageItem
- User
- UserActivityRow
- UserBrief
- UserBriefList
- UserCreate
- UserRowSlim
- UsersImportAction
- UsersImportCounts
- UsersImportInvitation
- UsersImportLimit
- UsersImportRequest
- UsersImportResult
- UsersImportRow
- UsersImportRowError
- UserUpdate
- ValidationError
- Verification
- VerificationEvent
- VerificationIntervalUpdate
- VerificationQueue
- VerificationQueueItem
- VerificationReason
- VerificationState
- VerificationType
- Verifier
- VerifierRef
- VerifierSet
- VerifierType
- VerifyCardRequest
- VerifyRequest
- ViewAs
- ViewAsOrg
- WebhookAttempt
- WebhookAttemptList
- WebhookAuthInput
- WebhookCatalog
- WebhookCatalogItem
- WebhookCreate
- WebhookCreated
- WebhookDelivery
- WebhookDeliveryBody
- WebhookDeliveryDetail
- WebhookDeliveryExpanded
- WebhookDeliveryList
- WebhookDeliveryStatus
- WebhookEndpoint
- WebhookEndpointList
- WebhookEvent
- WebhookEventFilter
- WebhookEventList
- WebhookEventObject
- WebhookEventType
- WebhookHeader
- WebhookHeaderInput
- WebhookHealth
- WebhookPayloadMode
- WebhookRedeliverRange
- WebhookRedeliverResult
- WebhookRole
- WebhookRotateSecret
- WebhookSecret
- WebhookStatus
- WebhookTestRequest
- WebhookUpdate