Referencia de la API
La API pública de Sursa: 222 endpoints en 35 secciones. Versión 1.62.0.
La API pública de Sursa para las integraciones que se autentican con una clave de API. Los cambios dentro de /v1 son aditivos: pueden aparecer operaciones nuevas, parámetros opcionales, campos de respuesta y valores de enumeración en las respuestas, y los clientes existentes siguen funcionando. Considere válidos los valores de enumeración desconocidos en las respuestas.
- URL base
- https://api.sursa.com
- Autenticación
- Envíe una clave de API en el encabezado Authorization: Authorization: Bearer <clave>.
Secciones
Estado y versión del servicio
Inicio de sesión, sesiones, modo «View as», cambio y restablecimiento de la contraseña, aceptación de invitaciones
Cuentas de usuario de la organización
Claves de API de la organización
Aplicaciones OAuth de la organización y autorizaciones de los empleados
El protocolo OAuth 2.0: pantalla de consentimiento, emisión y revocación de tokens, metadatos del servidor de autorización
Registro de auditoría de la organización
La organización, su logotipo y la exportación de datos
Categorías de documentos
Colecciones de conocimiento
Tarjetas de conocimiento: subida, contenido, tablas, versiones, verificación, comentarios
Cola de indexación: trabajos, vista previa del análisis, flujo de cambios (SSE)
Conversaciones con el asistente
Búsqueda y respuestas del asistente, incluido el flujo SSE
Solicitudes de acceso a las fuentes de una respuesta oculta
Registro de preguntas, sugerencias, exportaciones de respuestas, respuesta dinámica
Archivos de exportación
Análisis del conocimiento: resumen, duplicados, vacíos de conocimiento y salud del conocimiento
Tareas de un usuario y de un equipo
Fuentes de datos, como Google Drive y Confluence
Modelo de acceso: el registro de permisos y los permisos sobre la organización, las colecciones, las tarjetas y las fuentes, tanto concedidos directamente como heredados
Roles: conjuntos de permisos con nombre, integrados y personalizados
Grupos de usuarios: grupos normales, «All members», grupos de rol y grupos personales
Carpetas de las colecciones: un árbol de hasta tres niveles de profundidad, orden relativo a un elemento hermano, una tarjeta en varias carpetas, permisos heredados
Catálogo de servicios externos (SaaS y proveedores) con nombres, sitios web, categorías, iconos y descripciones, y vínculos entre los nombres de su organización y los elementos del catálogo
Borradores y aprobación de la publicación
Verificación: estado, fechas límite, verificadores, historial, la cola «Verify first», «Trust Score» y bajas
Avisos de lectura obligatoria: destinatarios, confirmación de lectura, informes, recordatorios, exportación
Comentarios de las tarjetas en hilos, con ancla y estado, y reacciones
Webhooks de la organización: registro de webhooks, suscripciones a eventos, firmas, entregas y reintentos
API pública para integraciones: la especificación legible por máquina de esta API
Subidas por partes de archivos grandes: la sesión, las partes, la finalización con comprobaciones y el uso en una tarjeta, un archivo comprimido o una importación
Analíticas del producto: eventos de uso, contadores por objeto, los paneles de salud, de uso y de contribución, el informe de renovación y las exportaciones
Calidad de las respuestas: preguntas sin una buena respuesta y los vacíos de conocimiento en los que se está trabajando
Documentos financieros: tipos de cambio y el directorio de contrapartes
Objetos
- 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