Platform type referenceType reference140 exported types

Ai governance sdk types

Field-level reference generated from source declarations and SDK export aliases.

On this page

ActivateVersionInputAiSystemInputAiSystemRecordAiSystemStatusAiSystemSummaryAiSystemSummaryParamsAiSystemTypeAiSystemUpdateInputApiKeyRecordApprovalConfigApprovalConfigInputApprovalListResponseApprovalRecordApprovalResolveInputApprovalResolveResponseApprovalSourceApprovalStatusArelisPlatformConfigAsyncJobResponseAsyncProofResponseAuditEventInputBatchEventInputBatchEventResponseBatchEventResultBillingSummaryResponseCausalGraphReplayRequestCausalGraphResponseComplianceProofRequestComplianceVerificationArtifactInputComplianceVerificationByIdInputComplianceVerificationInputCreateApiKeyInputCreateApiKeyResponseCreateEventResponseCreateExportInputCreateExportResponseCreateMcpServerInputCreateMcpServerToolInputCreatePolicyInputCreateProofResponseCreateVersionInputDownloadExportResponseEventCountParamsEventCountResponseEventRecordExportDetailRecordExportFormatExportRecordExportResourceExportStatusGovernanceSnapshotResponseGraphCommitResponseGraphLineageResponseGraphListItemGraphListParamsGraphListResponseHealthCheckResultJobListItemJobListResponseJobStatusResponseLinkedSystemRecordListAiSystemsParamsListAiSystemsResponseListApiKeysResponseListDecisionsParamsListDecisionsResponseListEventsParamsListEventsResponseListExportsParamsListExportsResponseListJobsParamsListMcpServersParamsListMcpServersResponseListPoliciesParamsListPoliciesResponseListProofsParamsListProofsResponseManagedPolicyManagedPolicyVersionMCPGovernedInvokeInputMCPGovernedInvokeResultMcpHealthStatusMcpServerHealthLogRecordMcpServerRecordMcpServersMethodsMcpServerStatusMcpServerToolRecordMcpServerUsageRecordMcpToolCapabilityMCPToolEvaluateInputMCPToolEvaluateResponseMCPToolPiiFindingMcpToolStatusMcpTransportTypeMilestoneConfigInputMilestoneConfigRecordMilestoneConfigResponseMilestoneDeliveryListResponseMilestoneDeliveryRecordOrganizationResponsePolicyEvaluateInputPolicyEvaluateResponsePolicyEvaluationHistoryRecordPolicyEvaluationHistoryResponseProofLayerProofRecordQuotaResponseReplayCompareInputReplayCompareResponseReplayDriftDiagnosticRecordReplayDriftSeverityReplayListItemReplayListParamsReplayListResponseReplayRequestReplayResultResponseReplayStepRecordReplayTemplateReplayTemplateInputReplayTemplateListResponseRetryJobResponseRiskDecisionRecordRiskEvaluationResponseRiskFactorRiskRouterConfigRuntimeRiskInputStreamConnectionTelemetryChallengeListResponseTelemetryReportListResponseToolRefreshResultUpdateApiKeyInputUpdateMcpServerInputUpdateMcpServerToolInputUpdatePolicyInputUsageHistoryEntryUsageHistoryResponseUsageOperationSummaryUsageSummaryResponseVerificationLayerResultVerifyProofResponse

ActivateVersionInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
versionnumberProperty

AiSystemInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
typeAiSystemTypeProperty
providerstringProperty · optional
modelRefstringProperty · optional
versionstringProperty · optional
descriptionstringProperty · optional
configRecord<string, unknown>Property · optional
metadataRecord<string, unknown>Property · optional
tagsstring[]Property · optional

AiSystemRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
slugstringProperty
namestringProperty
typeAiSystemTypeProperty
providerstring | nullProperty
modelRefstring | nullProperty
versionstring | nullProperty
statusAiSystemStatusProperty
isDefaultbooleanProperty
descriptionstring | nullProperty
configunknownProperty
metadataunknownProperty
tagsstring[]Property
createdAtstringProperty
updatedAtstringProperty

AiSystemStatus

typeAliasscripts/references/platform-client-reference.ts

Union Members

"active"
"archived"
"deprecated"

AiSystemSummary

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
aiSystem{ id: string; name: string; type: string }Property
period{ start: string; end: string }Property
events{ total: number; byType: Record<string, number> }Property
risk{ totalDecisions: number; byLevel: Record<string, number> }Property
proofs{ total: number }Property
policies{ evaluated: number; blocked: number; allowed: number }Property

AiSystemSummaryParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
startstringProperty · optional
endstringProperty · optional

AiSystemType

typeAliasscripts/references/platform-client-reference.ts

Union Members

"model"
"agent"
"pipeline"
"tool_chain"

AiSystemUpdateInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty · optional
typeAiSystemTypeProperty · optional
providerstring | nullProperty · optional
modelRefstring | nullProperty · optional
versionstring | nullProperty · optional
statusAiSystemStatusProperty · optional
descriptionstring | nullProperty · optional
configRecord<string, unknown> | nullProperty · optional
metadataRecord<string, unknown> | nullProperty · optional
tagsstring[] | nullProperty · optional

ApiKeyRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
prefixstringProperty
namestringProperty
scopesstring[]Property
createdAtstringProperty
expiresAtstring | nullProperty
revokedAtstring | nullProperty

ApprovalConfig

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
autoApprovebooleanProperty
autoApproveRulesunknown[]Property
timeoutMsnumber | nullProperty
escalationPolicyunknown | nullProperty
updatedAtstringProperty

ApprovalConfigInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
autoApprovebooleanProperty
autoApproveRulesunknown[]Property · optional
timeoutMsnumber | nullProperty · optional
escalationPolicyunknown | nullProperty · optional

ApprovalListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataApprovalRecord[]Property
configApprovalConfig | nullProperty
distinctApproversstring[]Property · optional
distinctApproverOptionsArray<{ id: string; name: string }>Property · optional
pagination{ total: number; limit: number; offset: number; }Property

ApprovalRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
runIdstringProperty
eventTypestringProperty
sourcestringProperty
statusApprovalStatusProperty
reasonstringProperty
contextunknownProperty
decidedBystring | nullProperty
decidedAtstring | nullProperty
createdAtstringProperty
actorunknownProperty
resourceunknownProperty
actionstringProperty
timestampstringProperty
metadataRecord<string, unknown> | nullProperty
derivedStatusApprovalStatusProperty
decidedByNamestring | nullProperty · optional
resolutionNotesstring | nullProperty · optional

ApprovalResolveInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
decision"approved" | "denied"Property
decidedBystringProperty · optional
notesstringProperty · optional

ApprovalResolveResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
approvalIdstringProperty
statusstringProperty
alreadyResolvedbooleanProperty · optional

ApprovalSource

typeAliasscripts/references/platform-client-reference.ts

Union Members

"policy_escalation"
"risk_escalation"
"manual"

ApprovalStatus

typeAliasscripts/references/platform-client-reference.ts

Union Members

"pending"
"approved"
"denied"
"expired"

ArelisPlatformConfig

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
baseUrlstringProperty
apiKeystringProperty · optional
tokenstringProperty · optional
maxRetriesnumberProperty · optional
timeoutnumberProperty · optional

AsyncJobResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
jobIdstringProperty

AsyncProofResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
jobIdstringProperty

AuditEventInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
eventTypestringProperty
actorstring | Record<string, unknown>Property
resourcestring | Record<string, unknown>Property
actionstringProperty
timestampstring | DateProperty
metadataRecord<string, unknown>Property · optional
aiSystemIdstringProperty · optional

BatchEventInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
eventsAuditEventInput[]Property

BatchEventResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
resultsBatchEventResult[]Property

BatchEventResult

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
eventIdstring | nullProperty
status"accepted" | "rejected"Property
reasonstringProperty · optional

BillingSummaryResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
organization{ id: string; name: string; tier: string; stripeCustomerId: string | null; }Property
currencystringProperty
currentScenario{ tier: string; totalProjected: number; rows: Array<{ operationType: string; used: number; includedLimit: number; overage: number; unitRate: number; projectedCharge: number; }>; }Property
comparison{ againstTier: string; deltaProjected: number; scenario: { tier: string; totalProjected: number; rows: Array<{ operationType: string; used: number; includedLimit: number; overage: number; unitRate: number; projectedCharge: number; }>; }; }Property

CausalGraphReplayRequest

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
nodes{ id: string; type: string; data: Record<string, unknown> }[]Property
edges{ source: string; target: string; type: string }[]Property
replaySnapshot{ policyHash?: string | null; modelRoute?: string | null; toolRegistryHash?: string | null; configStateHash?: string | null; }Property · optional

CausalGraphResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
runIdstringProperty
nodes{ id: string; type: string; data: Record<string, unknown> }[]Property
edges{ source: string; target: string; type: | "contains" | "sequence" | "parent" | "provisioned" | "configured" | "authenticated" | "discovered" | "agent_child"; }[]Property
digestMetadataRecord<string, unknown> | nullProperty
rootHashstring | nullProperty
createdAtstringProperty

ComplianceProofRequest

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
schemaVersion"v1" | "v2"Property · optional
disclosureRuleIdsstring[]Property · optional
composed{ layers?: string[]; narrowing?: Record<string, unknown>; lineage?: Record<string, unknown>; }Property · optional
asyncbooleanProperty · optional
aiSystemIdstringProperty · optional

ComplianceVerificationArtifactInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
proofIdstringProperty
runIdstringProperty
schemaVersion"v1" | "v2"Property
commitmentunknownProperty
proofHashstringProperty
layers{ name: string; hash: string; verified?: boolean }[]Property

ComplianceVerificationByIdInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
proofIdstringProperty

ComplianceVerificationInput

typeAliasscripts/references/platform-client-reference.ts

Union Members

ComplianceVerificationByIdInput
ComplianceVerificationArtifactInput

CreateApiKeyInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
scopesstring[]Property · optional
expiresAtstringProperty · optional

CreateApiKeyResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
prefixstringProperty
namestringProperty
scopesstring[]Property
rawKeystringProperty
createdAtstringProperty
expiresAtstring | nullProperty

CreateEventResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
eventIdstringProperty
runIdstringProperty

CreateExportInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
resourceExportResourceProperty
formatExportFormatProperty
filtersRecord<string, unknown>Property · optional
includeFieldsstring[]Property · optional

CreateExportResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
exportIdstringProperty
resourceExportResourceProperty
formatExportFormatProperty
statusExportStatusProperty
createdAtstringProperty

CreateMcpServerInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
uristringProperty
transportTypeMcpTransportTypeProperty
slugstringProperty · optional
trustLevelnumberProperty · optional
descriptionstringProperty · optional
tagsstring[]Property · optional
capabilitiesRecord<string, unknown>Property · optional
configRecord<string, unknown>Property · optional
metadataRecord<string, unknown>Property · optional

CreateMcpServerToolInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
descriptionstringProperty · optional
inputSchemaRecord<string, unknown>Property · optional
capabilityMcpToolCapabilityProperty · optional
metadataRecord<string, unknown>Property · optional

CreatePolicyInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
keystringProperty
namestringProperty
descriptionstringProperty · optional
conditionunknownProperty
actionstringProperty
severitystringProperty · optional
prioritynumberProperty · optional

CreateProofResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
proofIdstringProperty
runIdstringProperty
schemaVersionstringProperty
commitmentunknownProperty
proofHashstringProperty
layersProofLayer[]Property
createdAtstringProperty

CreateVersionInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
conditionunknownProperty
actionstringProperty
severitystringProperty · optional
changeSummarystringProperty · optional
metadataRecord<string, unknown>Property · optional

DownloadExportResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
fileNamestringProperty
mimeTypestringProperty
contentstringProperty

EventCountParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
eventTypestringProperty · optional
startTimestringProperty · optional
endTimestringProperty · optional

EventCountResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
countnumberProperty

EventRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
eventIdstringProperty
runIdstringProperty
eventTypestringProperty
actorunknownProperty
resourceunknownProperty
actionstringProperty
timestampstringProperty
serverTimestampstringProperty
metadataunknownProperty
aiSystemIdstring | nullProperty

ExportDetailRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
filtersRecord<string, unknown> | nullProperty
includeFieldsstring[]Property
artifactFileNamestring | nullProperty
artifactMimeTypestring | nullProperty
artifactSizeBytesnumber | nullProperty

ExportFormat

typeAliasscripts/references/platform-client-reference.ts

Union Members

"json"
"csv"

ExportRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
exportIdstringProperty
resourceExportResourceProperty
formatExportFormatProperty
statusExportStatusProperty
rowCountnumber | nullProperty
checksumSha256string | nullProperty
failureReasonstring | nullProperty
createdAtstringProperty
startedAtstring | nullProperty
completedAtstring | nullProperty
expiresAtstring | nullProperty

ExportResource

typeAliasscripts/references/platform-client-reference.ts

Union Members

"events"
"proofs"
"risk_decisions"
"replays"
"jobs"
"integrity"
"telemetry_reports"
"telemetry_challenges"
"usage_summary"
"usage_history"
"metering_milestones"
"metering_deliveries"
"policies"
"policy_evaluations"
"graphs"

ExportStatus

typeAliasscripts/references/platform-client-reference.ts

Union Members

"pending"
"processing"
"completed"
"failed"
"expired"

GovernanceSnapshotResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
policyHashstring | nullProperty
modelRoutestring | nullProperty
toolRegistryHashstring | nullProperty
configStateHashstring | nullProperty
rootHashstring | nullProperty
committedAtstring | nullProperty
related{ policyEvaluations: unknown[]; riskDecisions: unknown[]; complianceProofs: unknown[]; }Property · optional

GraphCommitResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
rootHashstringProperty
committedAtstringProperty

GraphLineageResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
nodeIdstringProperty · optional
nodes{ id: string; type: string; data: Record<string, unknown> }[]Property
edges{ source: string; target: string; type: | "contains" | "sequence" | "parent" | "provisioned" | "configured" | "authenticated" | "discovered" | "agent_child"; }[]Property
ancestorCountnumberProperty · optional
descendantCountnumberProperty · optional

GraphListItem

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
runIdstringProperty
rootHashstring | nullProperty
committedAtstring | nullProperty
createdAtstringProperty
nodeCountnumberProperty
edgeCountnumberProperty

GraphListParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
startTimestringProperty · optional
endTimestringProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional

GraphListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataGraphListItem[]Property
nextCursorstring | nullProperty

HealthCheckResult

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
statusstringProperty
latencyMsnumber | nullProperty
errorMessagestring | nullProperty
checkedAtstringProperty

JobListItem

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
jobIdstringProperty
type"proof" | "replay" | "export"Property
runIdstring | nullProperty
statusstringProperty
createdAtstringProperty
completedAtstring | nullProperty
durationMsnumber | nullProperty
errorSummarystring | nullProperty
resultunknownProperty
requestunknownProperty

JobListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataJobListItem[]Property
nextCursorstring | nullProperty

JobStatusResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
jobIdstringProperty
type"proof" | "replay" | "export"Property
statusstringProperty
runIdstring | nullProperty
requestunknownProperty · optional
resultunknownProperty
createdAtstringProperty
completedAtstring | nullProperty
retryEligiblebooleanProperty · optional

LinkedSystemRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
system{ id: string; name: string; slug: string; type: string; status: string; }Property
toolsunknownProperty
createdAtstringProperty

ListAiSystemsParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
typeAiSystemTypeProperty · optional
statusAiSystemStatusProperty · optional
providerstringProperty · optional
tagstringProperty · optional
searchstringProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional

ListAiSystemsResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataAiSystemRecord[]Property
nextCursorstring | nullProperty

ListApiKeysResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataApiKeyRecord[]Property

ListDecisionsParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
action"allow" | "flag" | "block" | "escalate"Property · optional
minScorenumberProperty · optional
maxScorenumberProperty · optional
startTimestringProperty · optional
endTimestringProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional
aiSystemIdstringProperty · optional

ListDecisionsResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataRiskDecisionRecord[]Property
nextCursorstring | nullProperty

ListEventsParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
eventTypestringProperty · optional
startTimestringProperty · optional
endTimestringProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional
aiSystemIdstringProperty · optional

ListEventsResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
eventsEventRecord[]Property
nextCursorstring | nullProperty

ListExportsParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
resourceExportResourceProperty · optional
statusExportStatusProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional

ListExportsResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataExportRecord[]Property
nextCursorstring | nullProperty

ListJobsParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
type"proof" | "replay" | "export"Property · optional
status"pending" | "processing" | "completed" | "failed" | "cancelled"Property · optional
runIdstringProperty · optional
startTimestringProperty · optional
endTimestringProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional

ListMcpServersParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
statusMcpServerStatusProperty · optional
transportTypeMcpTransportTypeProperty · optional
healthStatusMcpHealthStatusProperty · optional
searchstringProperty · optional
trustLevelMinnumberProperty · optional
trustLevelMaxnumberProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional

ListMcpServersResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataMcpServerRecord[]Property
nextCursorstring | nullProperty

ListPoliciesParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
statusstringProperty · optional
searchstringProperty · optional
includeDeletedbooleanProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional

ListPoliciesResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataManagedPolicy[]Property
nextCursorstring | nullProperty

ListProofsParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
cursorstringProperty · optional
limitnumberProperty · optional
aiSystemIdstringProperty · optional

ListProofsResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataProofRecord[]Property
nextCursorstring | nullProperty

ManagedPolicy

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
orgIdstringProperty
projectIdstringProperty
keystringProperty
namestringProperty
descriptionstring | nullProperty
statusstringProperty
prioritynumberProperty
activeVersionnumber | nullProperty
deletedAtstring | nullProperty
createdAtstringProperty
updatedAtstringProperty

ManagedPolicyVersion

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
policyIdstringProperty
versionnumberProperty
conditionunknownProperty
actionstringProperty
severitystringProperty
metadataunknownProperty
changeSummarystring | nullProperty
createdBystring | nullProperty
createdAtstringProperty

MCPGovernedInvokeInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
invoke() => Promise<T>Property
denyMode"throw" | "return"Property · optional

MCPGovernedInvokeResult

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
invokedbooleanProperty
decisionMCPToolEvaluateResponseProperty
resultTProperty · optional

McpHealthStatus

typeAliasscripts/references/platform-client-reference.ts

Union Members

"healthy"
"unhealthy"
"unknown"

McpServerHealthLogRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
statusstringProperty
latencyMsnumber | nullProperty
errorMessagestring | nullProperty
checkedAtstringProperty

McpServerRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
slugstringProperty
namestringProperty
uristringProperty
transportTypeMcpTransportTypeProperty
trustLevelnumberProperty
statusMcpServerStatusProperty
healthStatusMcpHealthStatusProperty
lastHealthCheckAtstring | nullProperty
toolRegistryHashstring | nullProperty
capabilitiesunknownProperty
configunknownProperty
metadataunknownProperty
tagsstring[] | nullProperty
descriptionstring | nullProperty
createdAtstringProperty
updatedAtstringProperty
_count{ tools?: number; usages?: number }Property · optional
toolCounts{ active: number; disabled: number; deprecated: number }Property · optional
linkedSystemCountnumberProperty · optional

McpServersMethods

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
createPromise<McpServerRecord>Method signature
listPromise<ListMcpServersResponse>Method signature
getPromise<McpServerRecord>Method signature
updatePromise<McpServerRecord>Method signature
archivePromise<McpServerRecord>Method signature
createToolPromise<McpServerToolRecord>Method signature
listToolsPromise<{ data: McpServerToolRecord[] }>Method signature
updateToolPromise<McpServerToolRecord>Method signature
refreshToolsPromise<ToolRefreshResult>Method signature
healthCheckPromise<HealthCheckResult>Method signature
healthHistoryPromise<{ data: McpServerHealthLogRecord[]; nextCursor: string | null }>Method signature
linkSystemPromise<McpServerUsageRecord>Method signature
unlinkSystemPromise<{ success: boolean }>Method signature
linkedSystemsPromise<{ data: LinkedSystemRecord[] }>Method signature

McpServerStatus

typeAliasscripts/references/platform-client-reference.ts

Union Members

"active"
"archived"

McpServerToolRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
namestringProperty
descriptionstring | nullProperty
inputSchemaunknownProperty
capabilityMcpToolCapabilityProperty
statusMcpToolStatusProperty
metadataunknownProperty
lastSeenAtstringProperty
createdAtstringProperty

McpServerUsageRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
serverIdstringProperty
systemIdstringProperty
toolsunknownProperty
createdAtstringProperty

McpToolCapability

typeAliasscripts/references/platform-client-reference.ts

Union Members

"read"
"write"
"execute"
"admin"

MCPToolEvaluateInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
serverIdstringProperty
toolNamestringProperty
toolArgsRecord<string, unknown>Property · optional
policyIdsstring[]Property · optional
actor{ id: string; type: string }Property · optional
serverTrustLevelnumberProperty · optional
toolCapabilitystringProperty · optional
transportTypestringProperty · optional

MCPToolEvaluateResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
decision"allow" | "deny" | "escalate"Property
originalDecision"allow" | "deny" | "escalate"Property · optional
pii{ hasPii: boolean; findings: MCPToolPiiFinding[]; }Property
policy{ allowed: boolean; decisions: Array<{ policyId: string; decision: string; metadata?: Record<string, unknown>; }>; summary: { allowed: boolean; blockReason?: string; blockCode?: string; }; policySetHash?: string; }Property
evaluatedAtstringProperty
approvalIdstring | nullProperty · optional
approvalApprovalAutomationMetadata | nullProperty · optional

MCPToolPiiFinding

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
typestringProperty
originalstringProperty
patternstringProperty · optional

McpToolStatus

typeAliasscripts/references/platform-client-reference.ts

Union Members

"active"
"disabled"
"deprecated"

McpTransportType

typeAliasscripts/references/platform-client-reference.ts

Union Members

"http"
"stdio"
"sse"

MilestoneConfigInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
operationType"audit_event" | "compliance_proof" | "risk_decision" | "replay_verification"Property
thresholdsnumber[]Property
notificationsEnabledbooleanProperty
webhookUrlstring | nullProperty · optional

MilestoneConfigRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
operationTypestringProperty
thresholdsnumber[]Property
notificationsEnabledbooleanProperty
webhookUrlstring | nullProperty
currentUsagenumberProperty
limitnumber | nullProperty

MilestoneConfigResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataMilestoneConfigRecord[]Property

MilestoneDeliveryListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataMilestoneDeliveryRecord[]Property
nextCursorstring | nullProperty

MilestoneDeliveryRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
orgIdstringProperty
projectIdstringProperty
operationTypestringProperty
milestonenumberProperty
currentUsagenumberProperty
limitnumberProperty
webhookUrlstring | nullProperty
statusstringProperty
responseCodenumber | nullProperty
errorstring | nullProperty
createdAtstringProperty

OrganizationResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
namestringProperty
slugstringProperty
regionstringProperty
complianceProfilestringProperty
dataRetentionPolicystringProperty
tierstringProperty
createdAtstringProperty

PolicyEvaluateInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
policiesunknown[]Property · optional
checkpointRecord<string, unknown>Property
policyIdsstring[]Property · optional

PolicyEvaluateResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
decisionsunknown[]Property
evaluatedAtstringProperty
policySetHashstring | nullProperty · optional
evaluatedPolicies{ id: string; version: number }[]Property · optional
approvalIdstring | nullProperty · optional
approvalApprovalAutomationMetadata | nullProperty · optional

PolicyEvaluationHistoryRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
runIdstring | nullProperty
policySourcestringProperty
policyCountnumberProperty
decisionsunknownProperty
checkpointunknownProperty
policySetHashstring | nullProperty
evaluatedAtstringProperty

PolicyEvaluationHistoryResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataPolicyEvaluationHistoryRecord[]Property
nextCursorstring | nullProperty

ProofLayer

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
hashstringProperty
verifiedbooleanProperty

ProofRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
proofIdstringProperty
runIdstringProperty
schemaVersionstringProperty
commitmentunknownProperty
proofHashstringProperty
layersProofLayer[]Property
metadataunknownProperty · optional
aiSystemIdstring | nullProperty
createdAtstringProperty

QuotaResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataArray<{ operationType: string; limit: number; action: string; currentPeriodUsage: number; periodStart: string | null; periodEnd: string | null; resetsAt: string | null; isDefault?: boolean; }>Property

ReplayCompareInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
baselineReplayIdstringProperty
candidateReplayIdstringProperty
setAsBaselinebooleanProperty · optional
baselineTemplateIdstringProperty · optional
notesstringProperty · optional

ReplayCompareResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
baselineReplayIdstringProperty
candidateReplayIdstringProperty
comparedAtstringProperty
summary{ new: number; resolved: number; unchanged: number; }Property
rows{ new: unknown[]; resolved: unknown[]; unchanged: unknown[]; }Property
links{ graphLineage: string; integrity: string; }Property

ReplayDriftDiagnosticRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
fieldstringProperty
expectedunknownProperty
actualunknownProperty
severityReplayDriftSeverityProperty

ReplayDriftSeverity

typeAliasscripts/references/platform-client-reference.ts

Union Members

"low"
"medium"
"high"

ReplayListItem

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
jobIdstringProperty
replayIdstring | nullProperty
runIdstringProperty
status"pending" | "processing" | "completed" | "failed"Property
stepsCountnumberProperty
warningsCountnumberProperty
driftCountnumberProperty
createdAtstringProperty
completedAtstring | nullProperty
errorstring | nullProperty · optional

ReplayListParams

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty · optional
status"pending" | "processing" | "completed" | "failed"Property · optional
cursorstringProperty · optional
limitnumberProperty · optional

ReplayListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataReplayListItem[]Property
nextCursorstring | nullProperty

ReplayRequest

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
replaySnapshot{ policyHash?: string | null; modelRoute?: string | null; toolRegistryHash?: string | null; configStateHash?: string | null; }Property · optional
aiSystemIdstringProperty · optional

ReplayResultResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
replayIdstringProperty
runIdstringProperty
stepsReplayStepRecord[] | unknownProperty
warningsstring[] | unknownProperty
driftDiagnosticsReplayDriftDiagnosticRecord[] | unknownProperty
createdAtstringProperty

ReplayStepRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
indexnumberProperty
eventIdstringProperty
status"match" | "drift" | "missing"Property
eventTypestringProperty
actionstringProperty
timestampstringProperty

ReplayTemplate

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
namestringProperty
descriptionstring | nullProperty
runIdstring | nullProperty
snapshot{ policyHash: string | null; modelRoute: string | null; toolRegistryHash: string | null; configStateHash: string | null; }Property
createdAtstringProperty
updatedAtstringProperty

ReplayTemplateInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
descriptionstringProperty · optional
runIdstringProperty · optional
snapshot{ policyHash?: string | null; modelRoute?: string | null; toolRegistryHash?: string | null; configStateHash?: string | null; }Property

ReplayTemplateListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataReplayTemplate[]Property
nextCursorstring | nullProperty

RetryJobResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
jobIdstringProperty
type"proof" | "replay" | "export"Property
retriedFromstringProperty
retryEligiblebooleanProperty

RiskDecisionRecord

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
runIdstringProperty
actionstringProperty
scorenumberProperty
factorsunknownProperty
deterministicInputsHashstringProperty
aiSystemIdstring | nullProperty
createdAtstringProperty

RiskEvaluationResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
idstringProperty
runIdstringProperty
actionstringProperty
originalActionstringProperty · optional
scorenumberProperty
factorsRiskFactor[]Property
deterministicInputsHashstringProperty
approvalIdstring | nullProperty
approvalApprovalAutomationMetadata | nullProperty · optional

RiskFactor

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
scorenumberProperty
weightnumberProperty
[index]unknownProperty

RiskRouterConfig

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
mode"adaptive" | "strict" | "permissive"Property
thresholds{ allow: number; flag: number; block: number; escalate: number; }Property
defaultAction"allow" | "flag" | "block" | "escalate"Property

RuntimeRiskInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
runIdstringProperty
policyDecisionsRecord<string, unknown>[]Property
quotaStateRecord<string, unknown>Property
evaluationSignalsRecord<string, unknown>[]Property
explicitSignalsRecord<string, unknown>Property · optional
aiSystemIdstringProperty · optional

StreamConnection

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
closevoidMethod signature

TelemetryChallengeListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataArray<{ id: string; reportId: string; status: string; expiresAt: string; verifiedAt: string | null; nonce: string; expectedDigestStatus: "pending" | "match" | "mismatch"; actualDigestStatus: "pending" | "match" | "mismatch"; verificationResult: string; expectedDigest: string; proofDigest: string | null; payloadHash: string; totalQuantity: number; createdAt: string; }>Property
nextCursorstring | nullProperty

TelemetryReportListResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
dataArray<{ id: string; projectId: string; status: string; verificationStatus: string; attestationStatus: string; windowStart: string; windowEnd: string; operationCounts: unknown; totalQuantity: number; payloadHash: string; signature: string; challenge: unknown; createdAt: string; }>Property
nextCursorstring | nullProperty

ToolRefreshResult

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
addedMcpServerToolRecord[]Property
updatedMcpServerToolRecord[]Property
deprecatedMcpServerToolRecord[]Property
unchangednumberProperty
toolRegistryHashstringProperty

UpdateApiKeyInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty · optional
scopesstring[]Property · optional

UpdateMcpServerInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty · optional
uristringProperty · optional
transportTypeMcpTransportTypeProperty · optional
trustLevelnumberProperty · optional
descriptionstring | nullProperty · optional
tagsstring[]Property · optional
capabilitiesRecord<string, unknown> | nullProperty · optional
configRecord<string, unknown> | nullProperty · optional
metadataRecord<string, unknown> | nullProperty · optional

UpdateMcpServerToolInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
statusMcpToolStatusProperty · optional
capabilityMcpToolCapabilityProperty · optional
metadataRecord<string, unknown>Property · optional

UpdatePolicyInput

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty · optional
descriptionstringProperty · optional
statusstringProperty · optional
prioritynumberProperty · optional
newVersion{ condition: unknown; action: string; severity?: string; changeSummary?: string; metadata?: Record<string, unknown>; }Property · optional

UsageHistoryEntry

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
datestringProperty
audit_eventnumberProperty
compliance_proofnumberProperty
risk_decisionnumberProperty
replay_verificationnumberProperty

UsageHistoryResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
entriesUsageHistoryEntry[]Property

UsageOperationSummary

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
operationTypestringProperty
usednumberProperty
limitnumber | nullProperty
percentagenumber | nullProperty

UsageSummaryResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
operationsUsageOperationSummary[]Property

VerificationLayerResult

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
namestringProperty
passedbooleanProperty
reasonstringProperty · optional

VerifyProofResponse

interfacescripts/references/platform-client-reference.ts
FieldTypeNotes
proofIdstringProperty
verifiedbooleanProperty
layersVerificationLayerResult[]Property
proofHashMismatchbooleanProperty · optional