Platform type referenceType reference140 exported types

Governance api client types

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

On this page

ActivateVersionInput AiSystemInput AiSystemRecord AiSystemStatus AiSystemSummary AiSystemSummaryParams AiSystemType AiSystemUpdateInput ApiKeyRecord ApprovalConfig ApprovalConfigInput ApprovalListResponse ApprovalRecord ApprovalResolveInput ApprovalResolveResponse ApprovalSource ApprovalStatus ArelisClientConfig AsyncJobResponse AsyncProofResponse AuditEventInput BatchEventInput BatchEventResponse BatchEventResult BillingSummaryResponse CausalGraphReplayRequest CausalGraphResponse ComplianceProofRequest ComplianceVerificationArtifactInput ComplianceVerificationByIdInput ComplianceVerificationInput CreateApiKeyInput CreateApiKeyResponse CreateEventResponse CreateExportInput CreateExportResponse CreateMcpServerInput CreateMcpServerToolInput CreatePolicyInput CreateProofResponse CreateVersionInput DownloadExportResponse EventCountParams EventCountResponse EventRecord ExportDetailRecord ExportFormat ExportRecord ExportResource ExportStatus GovernanceSnapshotResponse GraphCommitResponse GraphLineageResponse GraphListItem GraphListParams GraphListResponse HealthCheckResult JobListItem JobListResponse JobStatusResponse LinkedSystemRecord ListAiSystemsParams ListAiSystemsResponse ListApiKeysResponse ListDecisionsParams ListDecisionsResponse ListEventsParams ListEventsResponse ListExportsParams ListExportsResponse ListJobsParams ListMcpServersParams ListMcpServersResponse ListPoliciesParams ListPoliciesResponse ListProofsParams ListProofsResponse ManagedPolicy ManagedPolicyVersion MCPGovernedInvokeInput MCPGovernedInvokeResult McpHealthStatus McpServerHealthLogRecord McpServerRecord McpServersMethods McpServerStatus McpServerToolRecord McpServerUsageRecord McpToolCapability MCPToolEvaluateInput MCPToolEvaluateResponse MCPToolPiiFinding McpToolStatus McpTransportType MilestoneConfigInput MilestoneConfigRecord MilestoneConfigResponse MilestoneDeliveryListResponse MilestoneDeliveryRecord OrganizationResponse PolicyEvaluateInput PolicyEvaluateResponse PolicyEvaluationHistoryRecord PolicyEvaluationHistoryResponse ProofLayer ProofRecord QuotaResponse ReplayCompareInput ReplayCompareResponse ReplayDriftDiagnosticRecord ReplayDriftSeverity ReplayListItem ReplayListParams ReplayListResponse ReplayRequest ReplayResultResponse ReplayStepRecord ReplayTemplate ReplayTemplateInput ReplayTemplateListResponse RetryJobResponse RiskDecisionRecord RiskEvaluationResponse RiskFactor RiskRouterConfig RuntimeRiskInput StreamConnection TelemetryChallengeListResponse TelemetryReportListResponse ToolRefreshResult UpdateApiKeyInput UpdateMcpServerInput UpdateMcpServerToolInput UpdatePolicyInput UsageHistoryEntry UsageHistoryResponse UsageOperationSummary UsageSummaryResponse VerificationLayerResult VerifyProofResponse

ActivateVersionInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
version	number	Property

AiSystemInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
type	AiSystemType	Property
provider	string	Property · optional
modelRef	string	Property · optional
version	string	Property · optional
description	string	Property · optional
config	Record<string, unknown>	Property · optional
metadata	Record<string, unknown>	Property · optional
tags	string[]	Property · optional

AiSystemRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
slug	string	Property
name	string	Property
type	AiSystemType	Property
provider	string \| null	Property
modelRef	string \| null	Property
version	string \| null	Property
status	AiSystemStatus	Property
isDefault	boolean	Property
description	string \| null	Property
config	unknown	Property
metadata	unknown	Property
tags	string[]	Property
createdAt	string	Property
updatedAt	string	Property

AiSystemStatus

typeAliaspackages/api-client/src/index.ts

Union Members

"active"

"archived"

"deprecated"

AiSystemSummary

interfacepackages/api-client/src/index.ts

Field	Type	Notes
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

interfacepackages/api-client/src/index.ts

Field	Type	Notes
start	string	Property · optional
end	string	Property · optional

AiSystemType

typeAliaspackages/api-client/src/index.ts

Union Members

"model"

"agent"

"pipeline"

"tool_chain"

AiSystemUpdateInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property · optional
type	AiSystemType	Property · optional
provider	string \| null	Property · optional
modelRef	string \| null	Property · optional
version	string \| null	Property · optional
status	AiSystemStatus	Property · optional
description	string \| null	Property · optional
config	Record<string, unknown> \| null	Property · optional
metadata	Record<string, unknown> \| null	Property · optional
tags	string[] \| null	Property · optional

ApiKeyRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
prefix	string	Property
name	string	Property
scopes	string[]	Property
createdAt	string	Property
expiresAt	string \| null	Property
revokedAt	string \| null	Property

ApprovalConfig

interfacepackages/api-client/src/index.ts

Field	Type	Notes
autoApprove	boolean	Property
autoApproveRules	unknown[]	Property
timeoutMs	number \| null	Property
escalationPolicy	unknown \| null	Property
updatedAt	string	Property

ApprovalConfigInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
autoApprove	boolean	Property
autoApproveRules	unknown[]	Property · optional
timeoutMs	number \| null	Property · optional
escalationPolicy	unknown \| null	Property · optional

ApprovalListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ApprovalRecord[]	Property
config	ApprovalConfig \| null	Property
pagination	{ total: number; limit: number; offset: number; }	Property

ApprovalRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
runId	string	Property
eventType	string	Property
source	string	Property
status	ApprovalStatus	Property
reason	string	Property
context	unknown	Property
decidedBy	string \| null	Property
decidedAt	string \| null	Property
createdAt	string	Property

ApprovalResolveInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
decision	"approved" \| "denied"	Property
decidedBy	string	Property · optional
notes	string	Property · optional

ApprovalResolveResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
approvalId	string	Property
status	string	Property
alreadyResolved	boolean	Property · optional

ApprovalSource

typeAliaspackages/api-client/src/index.ts

Union Members

"policy_escalation"

"risk_escalation"

"manual"

ApprovalStatus

typeAliaspackages/api-client/src/index.ts

Union Members

"pending"

"approved"

"denied"

"expired"

ArelisClientConfig

interfacepackages/api-client/src/index.ts

Field	Type	Notes
baseUrl	string	Property
apiKey	string	Property · optional
token	string	Property · optional
maxRetries	number	Property · optional
timeout	number	Property · optional

AsyncJobResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
jobId	string	Property

AsyncProofResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
jobId	string	Property

AuditEventInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
eventType	string	Property
actor	string \| Record<string, unknown>	Property
resource	string \| Record<string, unknown>	Property
action	string	Property
timestamp	string \| Date	Property
metadata	Record<string, unknown>	Property · optional
aiSystemId	string	Property · optional

BatchEventInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
events	AuditEventInput[]	Property

BatchEventResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
results	BatchEventResult[]	Property

BatchEventResult

interfacepackages/api-client/src/index.ts

Field	Type	Notes
eventId	string \| null	Property
status	"accepted" \| "rejected"	Property
reason	string	Property · optional

BillingSummaryResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
organization	{ id: string; name: string; tier: string; stripeCustomerId: string \| null; }	Property
currency	string	Property
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

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
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

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
runId	string	Property
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
digestMetadata	Record<string, unknown> \| null	Property
rootHash	string \| null	Property
createdAt	string	Property

ComplianceProofRequest

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
schemaVersion	"v1" \| "v2"	Property · optional
disclosureRuleIds	string[]	Property · optional
composed	{ layers?: string[]; narrowing?: Record<string, unknown>; lineage?: Record<string, unknown>; }	Property · optional
async	boolean	Property · optional
aiSystemId	string	Property · optional

ComplianceVerificationArtifactInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
proofId	string	Property
runId	string	Property
schemaVersion	"v1" \| "v2"	Property
commitment	unknown	Property
proofHash	string	Property
layers	{ name: string; hash: string; verified?: boolean }[]	Property

ComplianceVerificationByIdInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
proofId	string	Property

ComplianceVerificationInput

typeAliaspackages/api-client/src/index.ts

Union Members

ComplianceVerificationByIdInput

ComplianceVerificationArtifactInput

CreateApiKeyInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
scopes	string[]	Property · optional
expiresAt	string	Property · optional

CreateApiKeyResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
prefix	string	Property
name	string	Property
scopes	string[]	Property
rawKey	string	Property
createdAt	string	Property
expiresAt	string \| null	Property

CreateEventResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
eventId	string	Property
runId	string	Property

CreateExportInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
resource	ExportResource	Property
format	ExportFormat	Property
filters	Record<string, unknown>	Property · optional
includeFields	string[]	Property · optional

CreateExportResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
exportId	string	Property
resource	ExportResource	Property
format	ExportFormat	Property
status	ExportStatus	Property
createdAt	string	Property

CreateMcpServerInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
uri	string	Property
transportType	McpTransportType	Property
slug	string	Property · optional
trustLevel	number	Property · optional
description	string	Property · optional
tags	string[]	Property · optional
capabilities	Record<string, unknown>	Property · optional
config	Record<string, unknown>	Property · optional
metadata	Record<string, unknown>	Property · optional

CreateMcpServerToolInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
description	string	Property · optional
inputSchema	Record<string, unknown>	Property · optional
capability	McpToolCapability	Property · optional
metadata	Record<string, unknown>	Property · optional

CreatePolicyInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
key	string	Property
name	string	Property
description	string	Property · optional
condition	unknown	Property
action	string	Property
severity	string	Property · optional
priority	number	Property · optional

CreateProofResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
proofId	string	Property
runId	string	Property
schemaVersion	string	Property
commitment	unknown	Property
proofHash	string	Property
layers	ProofLayer[]	Property
createdAt	string	Property

CreateVersionInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
condition	unknown	Property
action	string	Property
severity	string	Property · optional
changeSummary	string	Property · optional
metadata	Record<string, unknown>	Property · optional

DownloadExportResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
fileName	string	Property
mimeType	string	Property
content	string	Property

EventCountParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
eventType	string	Property · optional
startTime	string	Property · optional
endTime	string	Property · optional

EventCountResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
count	number	Property

EventRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
eventId	string	Property
runId	string	Property
eventType	string	Property
actor	unknown	Property
resource	unknown	Property
action	string	Property
timestamp	string	Property
serverTimestamp	string	Property
metadata	unknown	Property
aiSystemId	string \| null	Property

ExportDetailRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
filters	Record<string, unknown> \| null	Property
includeFields	string[]	Property
artifactFileName	string \| null	Property
artifactMimeType	string \| null	Property
artifactSizeBytes	number \| null	Property

ExportFormat

typeAliaspackages/api-client/src/index.ts

Union Members

"json"

"csv"

ExportRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
exportId	string	Property
resource	ExportResource	Property
format	ExportFormat	Property
status	ExportStatus	Property
rowCount	number \| null	Property
checksumSha256	string \| null	Property
failureReason	string \| null	Property
createdAt	string	Property
startedAt	string \| null	Property
completedAt	string \| null	Property
expiresAt	string \| null	Property

ExportResource

typeAliaspackages/api-client/src/index.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

typeAliaspackages/api-client/src/index.ts

Union Members

"pending"

"processing"

"completed"

"failed"

"expired"

GovernanceSnapshotResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
policyHash	string \| null	Property
modelRoute	string \| null	Property
toolRegistryHash	string \| null	Property
configStateHash	string \| null	Property
rootHash	string \| null	Property
committedAt	string \| null	Property
related	{ policyEvaluations: unknown[]; riskDecisions: unknown[]; complianceProofs: unknown[]; }	Property · optional

GraphCommitResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
rootHash	string	Property
committedAt	string	Property

GraphLineageResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
nodeId	string	Property · 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
ancestorCount	number	Property · optional
descendantCount	number	Property · optional

GraphListItem

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
runId	string	Property
rootHash	string \| null	Property
committedAt	string \| null	Property
createdAt	string	Property
nodeCount	number	Property
edgeCount	number	Property

GraphListParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
startTime	string	Property · optional
endTime	string	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

GraphListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	GraphListItem[]	Property
nextCursor	string \| null	Property

HealthCheckResult

interfacepackages/api-client/src/index.ts

Field	Type	Notes
status	string	Property
latencyMs	number \| null	Property
errorMessage	string \| null	Property
checkedAt	string	Property

JobListItem

interfacepackages/api-client/src/index.ts

Field	Type	Notes
jobId	string	Property
type	"proof" \| "replay" \| "export"	Property
runId	string \| null	Property
status	string	Property
createdAt	string	Property
completedAt	string \| null	Property
durationMs	number \| null	Property
errorSummary	string \| null	Property
result	unknown	Property
request	unknown	Property

JobListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	JobListItem[]	Property
nextCursor	string \| null	Property

JobStatusResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
jobId	string	Property
type	"proof" \| "replay" \| "export"	Property
status	string	Property
runId	string \| null	Property
request	unknown	Property · optional
result	unknown	Property
createdAt	string	Property
completedAt	string \| null	Property
retryEligible	boolean	Property · optional

LinkedSystemRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
system	{ id: string; name: string; slug: string; type: string; status: string; }	Property
tools	unknown	Property
createdAt	string	Property

ListAiSystemsParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
type	AiSystemType	Property · optional
status	AiSystemStatus	Property · optional
provider	string	Property · optional
tag	string	Property · optional
search	string	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

ListAiSystemsResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	AiSystemRecord[]	Property
nextCursor	string \| null	Property

ListApiKeysResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ApiKeyRecord[]	Property

ListDecisionsParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
action	"allow" \| "flag" \| "block" \| "escalate"	Property · optional
minScore	number	Property · optional
maxScore	number	Property · optional
startTime	string	Property · optional
endTime	string	Property · optional
cursor	string	Property · optional
limit	number	Property · optional
aiSystemId	string	Property · optional

ListDecisionsResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	RiskDecisionRecord[]	Property
nextCursor	string \| null	Property

ListEventsParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
eventType	string	Property · optional
startTime	string	Property · optional
endTime	string	Property · optional
cursor	string	Property · optional
limit	number	Property · optional
aiSystemId	string	Property · optional

ListEventsResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
events	EventRecord[]	Property
nextCursor	string \| null	Property

ListExportsParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
resource	ExportResource	Property · optional
status	ExportStatus	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

ListExportsResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ExportRecord[]	Property
nextCursor	string \| null	Property

ListJobsParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
type	"proof" \| "replay" \| "export"	Property · optional
status	"pending" \| "processing" \| "completed" \| "failed" \| "cancelled"	Property · optional
runId	string	Property · optional
startTime	string	Property · optional
endTime	string	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

ListMcpServersParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
status	McpServerStatus	Property · optional
transportType	McpTransportType	Property · optional
healthStatus	McpHealthStatus	Property · optional
search	string	Property · optional
trustLevelMin	number	Property · optional
trustLevelMax	number	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

ListMcpServersResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	McpServerRecord[]	Property
nextCursor	string \| null	Property

ListPoliciesParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
status	string	Property · optional
search	string	Property · optional
includeDeleted	boolean	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

ListPoliciesResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ManagedPolicy[]	Property
nextCursor	string \| null	Property

ListProofsParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
cursor	string	Property · optional
limit	number	Property · optional
aiSystemId	string	Property · optional

ListProofsResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ProofRecord[]	Property
nextCursor	string \| null	Property

ManagedPolicy

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
orgId	string	Property
projectId	string	Property
key	string	Property
name	string	Property
description	string \| null	Property
status	string	Property
priority	number	Property
activeVersion	number \| null	Property
deletedAt	string \| null	Property
createdAt	string	Property
updatedAt	string	Property

ManagedPolicyVersion

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
policyId	string	Property
version	number	Property
condition	unknown	Property
action	string	Property
severity	string	Property
metadata	unknown	Property
changeSummary	string \| null	Property
createdBy	string \| null	Property
createdAt	string	Property

MCPGovernedInvokeInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
invoke	() => Promise<T>	Property
denyMode	"throw" \| "return"	Property · optional

MCPGovernedInvokeResult

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
invoked	boolean	Property
decision	MCPToolEvaluateResponse	Property
result	T	Property · optional

McpHealthStatus

typeAliaspackages/api-client/src/index.ts

Union Members

"healthy"

"unhealthy"

"unknown"

McpServerHealthLogRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
status	string	Property
latencyMs	number \| null	Property
errorMessage	string \| null	Property
checkedAt	string	Property

McpServerRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
slug	string	Property
name	string	Property
uri	string	Property
transportType	McpTransportType	Property
trustLevel	number	Property
status	McpServerStatus	Property
healthStatus	McpHealthStatus	Property
lastHealthCheckAt	string \| null	Property
toolRegistryHash	string \| null	Property
capabilities	unknown	Property
config	unknown	Property
metadata	unknown	Property
tags	string[] \| null	Property
description	string \| null	Property
createdAt	string	Property
updatedAt	string	Property
_count	{ tools?: number; usages?: number }	Property · optional
toolCounts	{ active: number; disabled: number; deprecated: number }	Property · optional
linkedSystemCount	number	Property · optional

McpServersMethods

interfacepackages/api-client/src/index.ts

Field	Type	Notes
create	Promise<McpServerRecord>	Method signature
list	Promise<ListMcpServersResponse>	Method signature
get	Promise<McpServerRecord>	Method signature
update	Promise<McpServerRecord>	Method signature
archive	Promise<McpServerRecord>	Method signature
createTool	Promise<McpServerToolRecord>	Method signature
listTools	Promise<{ data: McpServerToolRecord[] }>	Method signature
updateTool	Promise<McpServerToolRecord>	Method signature
refreshTools	Promise<ToolRefreshResult>	Method signature
healthCheck	Promise<HealthCheckResult>	Method signature
healthHistory	Promise<{ data: McpServerHealthLogRecord[]; nextCursor: string \| null }>	Method signature
linkSystem	Promise<McpServerUsageRecord>	Method signature
unlinkSystem	Promise<{ success: boolean }>	Method signature
linkedSystems	Promise<{ data: LinkedSystemRecord[] }>	Method signature

McpServerStatus

typeAliaspackages/api-client/src/index.ts

Union Members

"active"

"archived"

McpServerToolRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
name	string	Property
description	string \| null	Property
inputSchema	unknown	Property
capability	McpToolCapability	Property
status	McpToolStatus	Property
metadata	unknown	Property
lastSeenAt	string	Property
createdAt	string	Property

McpServerUsageRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
serverId	string	Property
systemId	string	Property
tools	unknown	Property
createdAt	string	Property

McpToolCapability

typeAliaspackages/api-client/src/index.ts

Union Members

"read"

"write"

"execute"

"admin"

MCPToolEvaluateInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
serverId	string	Property
toolName	string	Property
toolArgs	Record<string, unknown>	Property · optional
policyIds	string[]	Property · optional
actor	{ id: string; type: string }	Property · optional
serverTrustLevel	number	Property · optional
toolCapability	string	Property · optional
transportType	string	Property · optional

MCPToolEvaluateResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
decision	"allow" \| "deny" \| "escalate"	Property
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
evaluatedAt	string	Property
approvalId	string \| null	Property · optional

MCPToolPiiFinding

interfacepackages/api-client/src/index.ts

Field	Type	Notes
type	string	Property
original	string	Property
pattern	string	Property · optional

McpToolStatus

typeAliaspackages/api-client/src/index.ts

Union Members

"active"

"disabled"

"deprecated"

McpTransportType

typeAliaspackages/api-client/src/index.ts

Union Members

"http"

"stdio"

"sse"

MilestoneConfigInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
operationType	"audit_event" \| "compliance_proof" \| "risk_decision" \| "replay_verification"	Property
thresholds	number[]	Property
notificationsEnabled	boolean	Property
webhookUrl	string \| null	Property · optional

MilestoneConfigRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
operationType	string	Property
thresholds	number[]	Property
notificationsEnabled	boolean	Property
webhookUrl	string \| null	Property
currentUsage	number	Property
limit	number \| null	Property

MilestoneConfigResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	MilestoneConfigRecord[]	Property

MilestoneDeliveryListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	MilestoneDeliveryRecord[]	Property
nextCursor	string \| null	Property

MilestoneDeliveryRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
orgId	string	Property
projectId	string	Property
operationType	string	Property
milestone	number	Property
currentUsage	number	Property
limit	number	Property
webhookUrl	string \| null	Property
status	string	Property
responseCode	number \| null	Property
error	string \| null	Property
createdAt	string	Property

OrganizationResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
name	string	Property
slug	string	Property
region	string	Property
complianceProfile	string	Property
dataRetentionPolicy	string	Property
tier	string	Property
createdAt	string	Property

PolicyEvaluateInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
policies	unknown[]	Property · optional
checkpoint	Record<string, unknown>	Property
policyIds	string[]	Property · optional

PolicyEvaluateResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
decisions	unknown[]	Property
evaluatedAt	string	Property
policySetHash	string \| null	Property · optional
evaluatedPolicies	{ id: string; version: number }[]	Property · optional

PolicyEvaluationHistoryRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
runId	string \| null	Property
policySource	string	Property
policyCount	number	Property
decisions	unknown	Property
checkpoint	unknown	Property
policySetHash	string \| null	Property
evaluatedAt	string	Property

PolicyEvaluationHistoryResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	PolicyEvaluationHistoryRecord[]	Property
nextCursor	string \| null	Property

ProofLayer

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
hash	string	Property
verified	boolean	Property

ProofRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
proofId	string	Property
runId	string	Property
schemaVersion	string	Property
commitment	unknown	Property
proofHash	string	Property
layers	ProofLayer[]	Property
metadata	unknown	Property · optional
aiSystemId	string \| null	Property
createdAt	string	Property

QuotaResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	Array<{ operationType: string; limit: number; action: string; currentPeriodUsage: number; periodStart: string \| null; periodEnd: string \| null; resetsAt: string \| null; isDefault?: boolean; }>	Property

ReplayCompareInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
baselineReplayId	string	Property
candidateReplayId	string	Property
setAsBaseline	boolean	Property · optional
baselineTemplateId	string	Property · optional
notes	string	Property · optional

ReplayCompareResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
baselineReplayId	string	Property
candidateReplayId	string	Property
comparedAt	string	Property
summary	{ new: number; resolved: number; unchanged: number; }	Property
rows	{ new: unknown[]; resolved: unknown[]; unchanged: unknown[]; }	Property
links	{ graphLineage: string; integrity: string; }	Property

ReplayDriftDiagnosticRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
field	string	Property
expected	unknown	Property
actual	unknown	Property
severity	ReplayDriftSeverity	Property

ReplayDriftSeverity

typeAliaspackages/api-client/src/index.ts

Union Members

"low"

"medium"

"high"

ReplayListItem

interfacepackages/api-client/src/index.ts

Field	Type	Notes
jobId	string	Property
replayId	string \| null	Property
runId	string	Property
status	"pending" \| "processing" \| "completed" \| "failed"	Property
stepsCount	number	Property
warningsCount	number	Property
driftCount	number	Property
createdAt	string	Property
completedAt	string \| null	Property
error	string \| null	Property · optional

ReplayListParams

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property · optional
status	"pending" \| "processing" \| "completed" \| "failed"	Property · optional
cursor	string	Property · optional
limit	number	Property · optional

ReplayListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ReplayListItem[]	Property
nextCursor	string \| null	Property

ReplayRequest

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
replaySnapshot	{ policyHash?: string \| null; modelRoute?: string \| null; toolRegistryHash?: string \| null; configStateHash?: string \| null; }	Property · optional
aiSystemId	string	Property · optional

ReplayResultResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
replayId	string	Property
runId	string	Property
steps	ReplayStepRecord[] \| unknown	Property
warnings	string[] \| unknown	Property
driftDiagnostics	ReplayDriftDiagnosticRecord[] \| unknown	Property
createdAt	string	Property

ReplayStepRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
index	number	Property
eventId	string	Property
status	"match" \| "drift" \| "missing"	Property
eventType	string	Property
action	string	Property
timestamp	string	Property

ReplayTemplate

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
name	string	Property
description	string \| null	Property
runId	string \| null	Property
snapshot	{ policyHash: string \| null; modelRoute: string \| null; toolRegistryHash: string \| null; configStateHash: string \| null; }	Property
createdAt	string	Property
updatedAt	string	Property

ReplayTemplateInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
description	string	Property · optional
runId	string	Property · optional
snapshot	{ policyHash?: string \| null; modelRoute?: string \| null; toolRegistryHash?: string \| null; configStateHash?: string \| null; }	Property

ReplayTemplateListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	ReplayTemplate[]	Property
nextCursor	string \| null	Property

RetryJobResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
jobId	string	Property
type	"proof" \| "replay" \| "export"	Property
retriedFrom	string	Property
retryEligible	boolean	Property

RiskDecisionRecord

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
runId	string	Property
action	string	Property
score	number	Property
factors	unknown	Property
deterministicInputsHash	string	Property
aiSystemId	string \| null	Property
createdAt	string	Property

RiskEvaluationResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
id	string	Property
runId	string	Property
action	string	Property
score	number	Property
factors	RiskFactor[]	Property
deterministicInputsHash	string	Property
approvalId	string \| null	Property

RiskFactor

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
score	number	Property
weight	number	Property
[index]	unknown	Property

RiskRouterConfig

interfacepackages/api-client/src/index.ts

Field	Type	Notes
mode	"adaptive" \| "strict" \| "permissive"	Property
thresholds	{ allow: number; flag: number; block: number; escalate: number; }	Property
defaultAction	"allow" \| "flag" \| "block" \| "escalate"	Property

RuntimeRiskInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
runId	string	Property
policyDecisions	Record<string, unknown>[]	Property
quotaState	Record<string, unknown>	Property
evaluationSignals	Record<string, unknown>[]	Property
explicitSignals	Record<string, unknown>	Property · optional
aiSystemId	string	Property · optional

StreamConnection

interfacepackages/api-client/src/index.ts

Field	Type	Notes
close	void	Method signature

TelemetryChallengeListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	Array<{ 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
nextCursor	string \| null	Property

TelemetryReportListResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
data	Array<{ 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
nextCursor	string \| null	Property

ToolRefreshResult

interfacepackages/api-client/src/index.ts

Field	Type	Notes
added	McpServerToolRecord[]	Property
updated	McpServerToolRecord[]	Property
deprecated	McpServerToolRecord[]	Property
unchanged	number	Property
toolRegistryHash	string	Property

UpdateApiKeyInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property · optional
scopes	string[]	Property · optional

UpdateMcpServerInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property · optional
uri	string	Property · optional
transportType	McpTransportType	Property · optional
trustLevel	number	Property · optional
description	string \| null	Property · optional
tags	string[]	Property · optional
capabilities	Record<string, unknown> \| null	Property · optional
config	Record<string, unknown> \| null	Property · optional
metadata	Record<string, unknown> \| null	Property · optional

UpdateMcpServerToolInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
status	McpToolStatus	Property · optional
capability	McpToolCapability	Property · optional
metadata	Record<string, unknown>	Property · optional

UpdatePolicyInput

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property · optional
description	string	Property · optional
status	string	Property · optional
priority	number	Property · optional
newVersion	{ condition: unknown; action: string; severity?: string; changeSummary?: string; metadata?: Record<string, unknown>; }	Property · optional

UsageHistoryEntry

interfacepackages/api-client/src/index.ts

Field	Type	Notes
date	string	Property
audit_event	number	Property
compliance_proof	number	Property
risk_decision	number	Property
replay_verification	number	Property

UsageHistoryResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
entries	UsageHistoryEntry[]	Property

UsageOperationSummary

interfacepackages/api-client/src/index.ts

Field	Type	Notes
operationType	string	Property
used	number	Property
limit	number \| null	Property
percentage	number \| null	Property

UsageSummaryResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
operations	UsageOperationSummary[]	Property

VerificationLayerResult

interfacepackages/api-client/src/index.ts

Field	Type	Notes
name	string	Property
passed	boolean	Property
reason	string	Property · optional

VerifyProofResponse

interfacepackages/api-client/src/index.ts

Field	Type	Notes
proofId	string	Property
verified	boolean	Property
layers	VerificationLayerResult[]	Property
proofHashMismatch	boolean	Property · optional