API-referens
Sursas offentliga API: 222 slutpunkter i 35 avsnitt. Version 1.62.0.
Sursas offentliga API för integrationer som autentiserar sig med en API-nyckel. Ändringar inom /v1 är tilläggsändringar: nya åtgärder, valfria parametrar, fält i svar och uppräkningsvärden i svar kan tillkomma, och befintliga klienter fortsätter att fungera. Behandla okända uppräkningsvärden i svar som giltiga.
- Bas-URL
- https://api.sursa.com
- Autentisering
- Skicka en API-nyckel i huvudet Authorization: Authorization: Bearer <nyckel>.
Avsnitt
Tjänstens status och version
Inloggning, sessioner, läget ”View as” (visa som en annan användare), ändring och återställning av lösenord, accepterande av inbjudningar
Organisationens användarkonton
Organisationens API-nycklar
Organisationens OAuth-appar och medarbetares auktoriseringar
Protokollet OAuth 2.0: samtyckesskärm, utfärdande och återkallelse av token, metadata för auktoriseringsservern
Organisationens granskningslogg
Organisationen, dess logotyp och dataexport
Dokumentkategorier
Kunskapssamlingar
Kunskapskort: uppladdning, innehåll, tabeller, versioner, verifiering, kommentarer
Indexeringskö: jobb, förhandsvisning av tolkningen, ändringsström (SSE)
Konversationer med assistenten
Sökning och assistentens svar, inklusive SSE-strömmen
Åtkomstbegäranden till källorna bakom ett dolt svar
Frågelogg, förslag, export av svar, live-svar
Exportfiler
Kunskapsinsikter: sammanfattning, dubbletter, kunskapsluckor och kunskapens hälsa
Uppgifter för en användare och för ett team
Datakällor, till exempel Google Drive och Confluence
Åtkomstmodell: behörighetsregistret och behörigheter för organisationen, samlingar, kort och källor, både direkt tilldelade och ärvda
Roller: namngivna uppsättningar behörigheter, inbyggda och anpassade
Användargrupper: vanliga grupper, ”All members” (alla medlemmar), rollgrupper och personliga grupper
Mappar i samlingar: ett träd med upp till tre nivåer, ordning i förhållande till ett element på samma nivå, ett kort i flera mappar, ärvda behörigheter
Katalog över externa tjänster (SaaS och leverantörer) med namn, webbplatser, kategorier, ikoner och beskrivningar samt kopplingar mellan din organisations namn och katalogposter
Utkast och godkännande för publicering
Verifiering: status, förfallodatum, granskare, historik, kön ”Verify first” (verifiera först), ”Trust Score” (förtroendepoäng) och offboarding
Meddelanden med obligatorisk läsning: målgrupp, läsbekräftelse, rapporter, påminnelser, export
Kommentarstrådar på kort med förankring och status samt reaktioner
Organisationens webhookar: själva webhookarna, prenumerationer på händelser, signaturer, leveranser och nya försök
Offentligt API för integrationer: den maskinläsbara specifikationen för detta API
Uppladdning av stora filer i delar (multipart): sessionen, delarna, slutförande med kontroller och användning i ett kort, ett arkiv eller en import
Produktanalys: användningshändelser, räknare per objekt, panelerna för hälsa, användning och bidrag, förnyelserapporten och exporter
Svarskvalitet: frågor utan ett bra svar och kunskapsluckor som har börjat åtgärdas
Finansiella dokument: växelkurser och motpartsregistret
Objekt
- 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