Schemas
ActiveUsersPeriodResponse
periodisPartialPeriodactiveUserCountActiveUsersRangeResponse
startendintervalActiveUsersResponse
generatedAttotalActiveUsersAnswerEngagementPeriodResponse
periodresponseCountresponseCopiestotalResponseCopiesresponseSourceClickedtotalSourcesClickedcopyRatesourceClickedRateisPartialPeriodtenantNameAnswerEngagementRangeResponse
startendintervalAnswerEngagementResponse
HelpfulAnswerRatePeriodResponse
periodtotalResponsesfeedbackpositiveFeedbacknegativeFeedbackisPartialPeriodfeedbackRatehelpfulAnswerRateunhelpfulAnswerRateHelpfulAnswerRateRangeResponse
startendintervalHelpfulAnswerRateResponse
generatedAtKnowledgeCreditsUsagePeriodResponse
periodchatResponsesmcpCreditsapiCreditsisPartialPeriodtotalCreditsKnowledgeCreditsUsageRangeResponse
startendintervalKnowledgeCreditsUsageResponse
totalCreditsMostActiveUserResponse
rankuserIddisplayNamequestionCountsourceOpenCountMostActiveUsersLeaderboardResponse
MostActiveUsersLeaderboardsResponse
MostActiveUsersRangeResponse
startendintervalMostActiveUsersResponse
generatedAtProblemDetails
typetitlestatusdetailinstanceQuestionsSubmittedPeriodResponse
periodisPartialPeriodtotalQueryCountQuestionsSubmittedQueryCountByChannelResponse
webUimcpapiQuestionsSubmittedRangeResponse
startendintervalQuestionsSubmittedResponse
generatedAtReportValidationProblemDetails
typetitlestatusdetailinstanceSearchableKnowledgePeriodResponse
periodnodesCreatedisPartialPeriodSearchableKnowledgeRangeResponse
startendintervalSearchableKnowledgeResponse
AccessControlListGrant
kindprovider^[a-z0-9]+(?:-[a-z0-… · requiredThe lowercase identity-provider namespace.
identifierA provider-owned identifier up to 256 characters long.
AclGrantMembershipAclRequest
kindThe ACL grant kind. Supported values are 'domain', 'group', 'user', and 'anyone'.
providerThe lowercase provider namespace for this ACL grant, such as 'slack'.
identifierThe provider-owned opaque identifier for this ACL grant.
AclGrantMembershipMemberRequest
providerThe lowercase provider namespace for this member, such as 'slack'.
identifierThe provider-owned opaque identifier for this member.
AclGrantMembershipSyncGrantRequest
One ACL grant reference from the request body.
The complete set of current members for this ACL grant. Use an empty array when the grant currently has no members. Grants with kind 'anyone' are always normalized to an empty member set.
AclGrantMembershipSyncGrantResultResponse
Identifies an ACL grant for a subject that may read the content. Membership resolution is performed by the provider named in StackInternal.ContentIngestion.Connectors.Models.AccessControlListGrant.Provider.
observedAtThe observedAt timestamp applied to this ACL grant.
grantedCountThe number of members granted by this request.
revokedCountThe number of members revoked by this request.
grantedChangeSetIdThe change-set id for granted members, or null when no grants were recorded.
revokedChangeSetIdThe change-set id for revoked members, or null when no revokes were recorded.
ArchetypeContentEnvelope
representationThe payload representation family.
representationVersionThe representation version used for this payload.
archetypeThe archetype name for the payload.
dataSchemaThe Dimension Registry schema identifier used to validate StackInternal.ContentIngestion.Connectors.Models.ArchetypeContentEnvelope.Data.
Archetype payload matching the supplied dataSchema.
ChangeArtifactArchetype
titleCommit subject, pull request title, release name, or other primary label for the change artifact.
changeTypeHigh-level change classification such as commit, pull request, release, patch, or version bump.
createdAtTimestamp describing when the change artifact was created.
authoredByPersonaRefObserved external identifier in the source system for the persona that authored, created, or published the change artifact. Resolution to a persona is based on the source value together with this persona reference and happens in the extraction domain.
stateCurrent state such as open, merged, closed, published, draft, or prerelease.
sourceUriDeep link to the change artifact in the source system.
descriptionTextCommit body, pull request description, release notes, or other long-form explanation of the change.
updatedAtTimestamp describing the latest metadata update for the change artifact.
baseRefReference to the target branch, previous version, or prior state of the change.
headRefReference to the source branch, head SHA, or new state introduced by the change.
mergedOrPublishedAtTimestamp describing when the change was merged, landed, or published.
linkedWorkItemRefsJsonJSON-serialized collection of related issues, tickets, milestones, or other work-tracking links.
reviewMessageRefsJsonJSON-serialized collection of review entries and review comments associated with the change.
metadataJsonJSON-serialized source-specific metadata such as SHA, tag, file stats, merge queue state, or target commitish.
ContainerArchetype
displayNameDisplay name for the container, such as a repository, channel, project, team, or space name.
containerTypeHigh-level container classification such as space, repository, board, team, channel, project, room, or service.
ownerRefsObserved external identifiers in the source system for the owners, leads, maintainers, or administrators for the container. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
sourceUriDeep link to the container in the source system.
descriptionTextPurpose, charter, topic, or description that explains what the container is for.
createdAtTimestamp describing when the container was created.
updatedAtTimestamp describing the most recent metadata change to the container.
visibilityVisibility or access state such as public, private, internal, shared, or archived.
parentContainerRefReference to a parent organization, team, portfolio, or space when one exists.
metadataJsonJSON-serialized source-specific container metadata such as default branch, topic, moderation settings, or billing linkage.
ConversationArchetype
conversationTypeHigh-level conversation classification such as direct message, group chat, channel thread, comment thread, or Q&A thread.
startedAtTimestamp describing when the conversation began.
lastActivityAtTimestamp of the most recent message or activity associated with the conversation.
participantRefsObserved external identifiers in the source system for the participants involved in the conversation. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
sourceUriDeep link to the chat, thread, or channel in the source system.
titleChannel name, thread subject, topic, or another human-readable label for the conversation.
summaryOptional synopsis of the discussion to help consumers understand the exchange quickly.
Ordered collection of normalized message archetype instances materialized for the conversation when callers need the usable thread shape.
messageCountNumber of messages currently known for the conversation when the source exposes that count.
containerRefReference to the workspace, team, channel, space, or project that contains the conversation.
statusConversation state such as active, closed, archived, resolved, or locked.
metadataJsonJSON-serialized source-specific conversation metadata such as thread IDs, visibility, or reply counters.
DocumentArchetype
titleHuman-readable name of the document or document-like artifact.
textContentExtracted body text, OCR text, or the normalized textual representation of the document content.
documentTypeHigh-level document classification such as page, file, blog post, note, knowledge article, or attachment.
personaRefsObserved external identifiers in the source system for the people who created or most recently edited the document. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
sourceUriCanonical deep link back to the document in the source system.
summaryOptional source-provided or generated synopsis that helps a reader understand the document quickly.
createdAtTimestamp describing when the source document was first created.
lastModifiedAtTimestamp describing the most recent source-side modification to the document.
containerRefReference to the parent space, repository, drive, folder, channel, or project that contains the document.
mimeTypeMIME type for file-backed content when the source exposes one.
languageNatural language code or label for the extracted content when it is known.
tagsJsonJSON-serialized collection of labels, categories, or source taxonomies associated with the document.
statusLifecycle or publication state such as draft, published, archived, deleted, or current.
sourceVersionSource-specific version number, revision identifier, or current document revision label.
metadataJsonJSON-serialized source-specific metadata that does not cleanly promote to a canonical document property.
HttpValidationProblemDetails
typetitlestatusdetailinstanceInsertContentV3Request
sourceThe upstream system that produced the content, such as 'github' or 'slack'.
sourceIdThe stable identifier from the upstream system for this content item. The combination of source and sourceId must be unique within the tenant.
sourceUriThe absolute URI of the content item in the upstream system.
The access control entries that define who can view the content.
entityTypeThe source-specific entity type for this content item, such as 'markdown-file' or 'message'.
Standardized archetype envelope used for transport and storage.
hierarchyThe optional absolute URI-shaped container hierarchy for this content item.
Optional root-to-leaf containers with stable IDs and display names. Requires a matching hierarchy URI.
InsertContentV3Response
contentIdThe unique identifier of the stored content version that was created.
LegacyJsonContentDataResponse
MessageArchetype
textContentThe message body or normalized textual content of the utterance.
messageTypeHigh-level message classification such as chat, comment, review, reply, Q&A, note, or announcement.
createdAtTimestamp describing when the message was first created or submitted.
personaRefObserved external identifier in the source system for the persona that authored or sent the message. Resolution to a persona is based on the source value together with this persona reference and happens in the extraction domain.
sourceUriDeep link to the exact message in the source system.
titleOptional subject line, heading, or generated snippet for the message.
lastModifiedAtTimestamp of the latest source-tracked edit to the message.
conversationRefReference to the parent conversation when the message belongs to one.
parentRefReference to the immediate parent object such as a work item, document, message, or review object.
replyToRefReference to the direct parent message or comment when the source models threaded replies.
mentionsObserved external identifiers in the source system for mentioned personas or entities captured from the message. Resolution to a persona or other mentioned identity is based on the source value together with each mention reference and happens in the extraction domain.
attachmentsJsonJSON-serialized collection of attachments or linked artifacts associated with the message.
reactionsJsonJSON-serialized reaction counts or structured reaction metadata captured for the message.
metadataJsonJSON-serialized source-specific message metadata such as subtype, importance, visibility, or line context.
MetricSnapshotArchetype
metricFamilyBroad measurement family such as usage, attendance, traffic, queue performance, or SLA.
subjectRefReference to the user, team, organization, repository, session, queue, service, or other subject being measured.
capturedAtTimestamp of the snapshot capture or the representative timestamp for the measured period.
measurementsJsonJSON-serialized map of numeric measurements keyed by metric name.
sourceUriDeep link to the source report or metric record when the source provides one.
periodStartAtStart timestamp for the measured period when the snapshot covers a window of time.
periodEndAtEnd timestamp for the measured period when the snapshot covers a window of time.
dimensionsJsonJSON-serialized dimension bag describing slice values such as language, IDE, model, queue, channel, or feature.
aggregationLevelLevel at which the metrics were aggregated, such as user, team, org, repo, session, or queue.
metadataJsonJSON-serialized source-specific rollup metadata such as sample counts, report IDs, or derived counters.
PutAclGrantMembershipsV3Request
sourceThe registered API-managed source or authorized internal connector source that owns this ACL membership snapshot.
observedAtThe time this snapshot was observed in the upstream system.
The ACL grants to replace. Each grant is a full replacement of its current member set.
PutAclGrantMembershipsV3Response
runIdThe synthetic ingestion run recorded for this request.
Per-grant grant and revoke counts derived from the applied membership changes.
SessionArchetype
titleHuman-readable session name, topic, or generated label.
sessionTypeHigh-level session classification such as meeting, webinar, call, event, or SMS session.
startAtTimestamp describing when the session started or is scheduled to start.
hostRefsObserved external identifiers in the source system for host, organizer, or owner personas. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
participantRefsObserved external identifiers in the source system for participants, attendees, panelists, or registrants. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
statusSession state such as scheduled, live, completed, canceled, or no-show.
sourceUriDeep link back to the session record in the source system.
descriptionTextAgenda, description, or source-provided summary of what the session is about.
endAtTimestamp describing when the session ended or is scheduled to end.
durationSecondsDuration of the session in whole seconds when that value is known.
joinUrlJoin URL or entry point for the session when one is appropriate to retain.
containerRefReference to the team, channel, account, hub, or other organizational boundary that contains the session.
transcriptTextNormalized spoken transcript or transcript excerpt associated with the session.
recordingRefsJsonJSON-serialized collection of linked recordings or related session artifacts.
metadataJsonJSON-serialized source-specific session metadata such as timezone, attendance stats, poll linkage, or telephony fields.
SourceEventArchetype
eventTypeName or classification of the source occurrence being captured.
occurredAtTimestamp describing when the event happened.
actorRefsObserved external identifiers in the source system for the personas, systems, or services that caused the event. Resolution to a persona or other actor identity is based on the source value together with each actor reference and happens in the extraction domain.
subjectRefReference to the primary thing the event happened to.
sourceUriDeep link to the event in the source system when the source exposes one.
titleOptional short label or generated summary for the event.
containerRefReference to the repository, project, channel, service, or other grouping context around the event.
statusOutcome or resulting state associated with the event when that meaning is useful.
payloadTextReadable normalized event description or textual payload content.
payloadJsonJSON-serialized raw or normalized event payload for cases where structured details matter.
metadataJsonJSON-serialized source-specific event metadata such as environment, headers, batch IDs, or alert tags.
StructuredRecordArchetype
recordTypeBroad business-object classification for the structured record.
fieldsJsonJSON-serialized map of canonicalized key-value attributes that capture the record payload.
ownerRefsObserved external identifiers in the source system for owners, requesters, maintainers, or other linked people for the record. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
sourceUriDeep link to the structured record in the source system.
titleBest human-readable label for the record when the source exposes one.
summaryOptional generated or source-provided synopsis of the record.
textContentFlattened textual representation of the most important string fields for retrieval and summarization scenarios.
statusCurrent state of the record when state is meaningful.
createdAtTimestamp describing when the record was created.
updatedAtTimestamp describing the most recent update to the record.
containerRefReference to the project, service, event, repository, organization, or other grouping context for the record.
metadataJsonJSON-serialized source-specific attributes that should remain outside the canonical structured surface.
UpdateContentV3Request
sourceUriThe absolute URI of the content item in the upstream system.
The access control entries that define who can view the content.
entityTypeThe source-specific entity type for this content item, such as 'markdown-file' or 'message'.
Standardized archetype envelope used for transport and storage.
hierarchyThe optional absolute URI-shaped container hierarchy for this content item.
Optional root-to-leaf containers with stable IDs and display names. Requires a matching hierarchy URI. If omitted, stored segments are preserved only while the hierarchy path is unchanged.
WorkItemArchetype
titleShort summary or primary human-readable description of the work item.
workItemTypeHigh-level workflow classification such as issue, incident, request, task, change, approval, or problem.
statusCurrent lifecycle state of the work item.
createdAtTimestamp describing when the work item was created.
openedByPersonaRefObserved external identifier in the source system for the persona that reported, requested, or created the work item. Resolution to a persona is based on the source value together with this persona reference and happens in the extraction domain.
assigneeRefsObserved external identifiers in the source system for current owners, assignees, or responders. Resolution to personas is based on the source value together with each persona reference and happens in the extraction domain.
sourceUriDeep link to the work item in the source system.
descriptionTextLong-form description, body text, or normalized rich-text content explaining the work item.
priorityUrgency or importance value supplied by the source system.
updatedAtTimestamp describing the most recent source-side update to the work item.
dueAtDue date or target completion timestamp when the source tracks one.
resolutionResolution code, closure note, or final outcome for the work item.
labelsJsonJSON-serialized collection of tags, components, or other categorization labels.
containerRefReference to the project, board, service, repository, or space that owns the work item.
messageRefsJsonJSON-serialized collection of related comments, reviews, or discussion entries.
metadataJsonJSON-serialized source-specific workflow metadata such as severity, sprint, milestone, SLA, or custom fields.
DsrAccessRequest
emailThe email address associated with the data subject for the DSR access request.
DsrAccessResponse
existsWhether matching data exists.
messagesAdditional messages.
emailsEmail addresses.
ipsIP addresses.
namesNames.
locationsLocations.
addressesStreet addresses.
citiesCities.
statesStates or regions.
countriesCountries.
postalCodesPostal codes.
companyNamesCompany names.
titlesJob titles.
cookiesCookie values.
aboutMeAbout-me content.
urlsURLs.
phonesPhone numbers.
mobilePhonesMobile phone numbers.
userIdsUser IDs.
accountIdsAccount IDs.
anonymousAccountWhether the account is anonymous.
notesAdditional notes.
DsrExportRequest
emailThe email address associated with the data subject for the DSR access request.
DsrExportResponse
existsWhether matching data exists.
messagesAdditional messages.
dataSchemaURI of the exported data schema.
Exported data.
DsrEraseRequest
emailThe email address associated with the data subject for the DSR access request.
DsrEraseResponse
existsWhether matching data exists.
messagesAdditional messages.
GetNodesByIdsRequest
nodeIdsNode IDs to retrieve. Duplicates are ignored.
GetNodesByIdsResponse
The matching nodes keyed by node ID. Missing requested IDs are omitted.
SearchRequest
queryThe search query, which must contain at least one non-whitespace character.
limitThe number of results to return.
algorithmThe search algorithm to use.
scopeIdsThe scope IDs to filter search results by.
SearchResponse
hasIndexedNodesIndicates whether the tenant search index is available for node search. This is false only when the tenant index does not exist. When this is true and results is empty, the index exists but either contains no indexed nodes or no nodes matched the query.
The search results.
totalTotal number of matching nodes.
userAclGrantsThe ACL grant tags resolved for the requesting user. Each string is a JSON array containing the subject provider, kind, and external ID.
SearchResult
A persisted node.
scoreRelative relevance score (higher is better).
CreateNodeSnapshotRequest
requestIdCaller-owned idempotency identifier, normally the Trust onboarding-cycle ID.
CreateNodeSnapshotResponse
requestIdsnapshotIdstatusReprocessResponse
totalFetchedTotal number of source content items fetched from ContentIngestion.
totalProcessedTotal number of source content items processed into nodes.
pagesTotal number of ContentIngestion pages fetched.
nextCursorOpaque cursor to resume reprocessing from, or null when there are no more items.
ScopeBackfillRequest
source^[A-Za-z0-9-]+$ · requiredContent source identifier, such as googledrive or slack. Case-insensitive.
maxItemsMaximum number of matching content items to examine, including stale or failed items. Omit or set to null to process all remaining items.
cursorOpaque NextCursor from a backfill with no failed or invalid items for the same tenant and source. Omit or set to null to start from the beginning.
ScopeBackfillResponse
jobIdDeveloperRemoveTenantNodeDataRequest
tenantIdsTenant IDs to remove. Duplicates are ignored.
DeveloperRemoveTenantNodeDataResponse
Per-tenant deletion results.
DeveloperRemoveTenantNodeDataTenantResponse
tenantIdTenant ID.
deletedNodesNumber of deleted node rows.
indexNamesElasticsearch indices deleted for the tenant.
Node
nodeIdNode ID.
textThe node text.
classificationSignalsSignals used to classify the node.
Creation metadata for the node.
Ingestion metadata for the node.
Trust evaluation data.
Relations with other nodes.
deletedWhether the node is deleted.
tenantIdTenant ID
contentIdContent ID.
externalSourceUrlHuman-resolvable URL of this node at its external source system. Distinct from ingestionMetadata.source (the system name, e.g. "stackinternalcommunity") and ingestionMetadata.sourceId (the source's internal identifier, e.g. "5") — this is the link a human would follow to read the original content. Null when the source does not expose a stable URL.
Document-specific metadata.
Explicit user engagement data from the source system.
Author
userIdThe external user ID.
internalUserIdThe internal user ID.
CreationMetadata
createdAtWhen the content was created.
Author information.
editedAtWhen the content was last edited.
ExplicitUserEngagementDimension
scoreThe source-system score.
viewsThe source-system view count.
IngestionMetadata
source^[a-zA-Z0-9\-]+\z · requiredThe content source.
sourceIdThe source identifier.
ingestedAtWhen the node was ingested.
ingestedByWho ingested the node.
archetypeTypeThe content archetype type, when extracted from an archetype payload.
archetypeVersionThe content archetype version, when extracted from an archetype payload.
Context about the source.
NodeRelation
typeThe Node relation type.
sourceNodeIdThe source node ID.
targetNodeIdThe target node ID.
isAcceptedFor answer/question relations, the accepted state of the answer participating in the relation.
NodeRelationType
The Node relation type.
SourceContext
idThe source context ID.
nameThe source context name.
TrustDimension
scoreThe trust score from 0.00 to 1.00.
evaluatorVersionVersion of the trust evaluator.
assignedAtWhen the trust score was assigned.
knowledge.ProblemDetails
typeA URI reference that identifies the problem type.
titleA short, human-readable summary of the problem type.
statusThe HTTP status code generated by the origin server for this occurrence of the problem.
detailA human-readable explanation specific to this occurrence of the problem.
instanceA URI reference that identifies the specific occurrence of the problem.
Validation errors associated with the request.
OAuthApplicationRequest
namedescriptionredirectUrisscopesOAuthApplicationResponse
idclientIdnamedescriptionredirectUrisscopescreatedAtupdatedAtOAuthApplicationScopeOptionResponse
slugnamedescriptionresourceTypeSlugsystemOAuthApplicationSortField
Fields the OAuth application list can be sorted by.
OAuthApplicationsListResponse
pagepageSizetotalCountUserListItemResponse
userIdemailfirstNamelastNameroleisActiveUserListItemResponsePagedResult
pagepageSizetotalCountUserSearchRequest
pageThe one-based page number. Values below one are treated as one.
pageSizeThe number of results per page, from 1 through 100.
qOptional text filter, matched against name and email.
roleOptional exact role filter.
statusOptional active-state filter. Accepted values are active or deactivated.
userIdsOptional user IDs to include.
sortFields the user list can be sorted by. "Name" sorts on first + last name.
directionSort order: ascending or descending.
UserSortField
Fields the user list can be sorted by. "Name" sorts on first + last name.
ValidationConflictLifecycle
requestedAtTime the validation request was created, in UTC.
sentAtTime the validation attempt was sent, in UTC.
respondedAtTime the SME responded, in UTC, when recorded.
completedAtTime processing of the SME response completed, in UTC, when recorded.
expiresAtTime the validation attempt expires, in UTC, when recorded.
ValidationConflictResponse
eventIdStable external identifier for this validation attempt. Example: validation-attempt-317.
validationRequestIdPersisted validation request identifier.
attemptIdPersisted validation attempt identifier.
statusValidation outcome: sme_verified when the SME approved the suggestion, or sme_updated when the SME edited it.
topicNameTenant topic name, when one is available.
questionQuestion presented to the SME during validation.
suggestedAnswerSuggested answer captured when the validation request was created.
validatedAnswerSME-validated answer. For sme_updated results, this is the saved edited content when available; it may be null for older edited attempts without persisted content. For sme_verified results, it matches suggestedAnswer.
External source references from the saved validation snapshot. When sourceType is supplied, only matching sources are included.
ValidationConflictRoutedTo
typeRecipient type, such as Sme or Channel.
identifierCanonical recipient name when available; otherwise the stored recipient identifier.
statusCurrent routing attempt status.
ValidationConflictSourceDocument
systemSource system or type. Example: confluence.
titleExternal document title, when available.
urlExternal source URL, when available.
authorSource author, when available.
sourceDateSource creation or publication date, when available. Returned as a UTC timestamp.
ValidationConflictValidation
sourceIdentifier of the message associated with the validation.
conversationIdConversation identifier associated with the validation.
verifiedAtTime the validation was resolved, in UTC.
ValidationConflictsResponse
The current page of SME validations with source context.
nextCursorOpaque cursor for the next page, or null when there are no more results. When another match establishes more results, it continues after the last returned validation; if the scan limit is reached before an additional match is found, it continues after the last examined attempt and may accompany an empty validations array.