Schemas
AccessControlListGrant
kindprovider^[a-z0-9]+(?:-[a-z0-… · requiredThe lowercase identity-provider namespace.
identifier^[A-Za-z0-9\-._~!$&'… · requiredA provider-owned identifier using RFC 3986 URI characters, except colon. Colon is reserved as an internal delimiter.
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.
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.
InsertContentV3Response
contentIdThe unique identifier of the stored content version that was created.
LegacyJsonContentDataResponse
content.ProblemDetails
typetitlestatusdetailinstanceUpdateContentV3Request
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.
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.
limitThe number of results to return.
algorithmThe search algorithm to use.
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.
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.
DeveloperRemoveTenantNodeDataRequest
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.
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.
Trust evaluation data.
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.
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.
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.