@intutic/clawde
Classes
Interfaces
AdjudicateOptions
Properties
| Property | Type |
|---|---|
note? | string |
AttenuateOptions
Properties
| Property | Type | Description |
|---|---|---|
ttlSeconds? | number | 60 to 86400 seconds. |
AttenuationChainLink
Properties
| Property | Type |
|---|---|
chainId | string |
childKeyId | string |
createdAt | string |
expiresAt | string |
grantedCaps | string[] |
parentKeyId | string |
workspaceId | string |
AttenuationResult
Properties
| Property | Type | Description |
|---|---|---|
attenuationChainId | string | - |
childKey | string | The child vk_ key: shown once, never stored. |
childKeyId | string | - |
expiresAt | string | - |
grantedCaps | string[] | - |
AuthoredGuardrailInput
Properties
| Property | Type | Description |
|---|---|---|
description? | string | null | - |
ir | Record<string, unknown> | - |
name | string | One line. |
AuthoredGuardrailUpdate
Any of the three. A changed IR creates the next version; description: null clears it.
Properties
| Property | Type |
|---|---|
description? | string | null |
ir? | Record<string, unknown> |
name? | string |
AuthoredGuardrailWriteResult
Properties
| Property | Type | Description |
|---|---|---|
forked | boolean | The IR changed: a new version, PROPOSED with no evidence, replaced the old one, which is now RETIRED. |
guardrail | GuardrailDetail | The guardrail read back after the write. |
ok | true | - |
supersedes | string | null | - |
BranchUsage
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
branch | string | null | - | - |
commitCount | number | - | - |
lastCallAt | string | - | - |
repo | string | null | Null on the row for calls made with no git context. | - |
totalCostUsd | number | - | UsageTotals.totalCostUsd |
totalInputTokens | number | - | UsageTotals.totalInputTokens |
totalOutputTokens | number | - | UsageTotals.totalOutputTokens |
totalRawCostUsd | number | - | UsageTotals.totalRawCostUsd |
traceCount | number | - | UsageTotals.traceCount |
BranchUsageResponse
Properties
| Property | Type |
|---|---|
branches | BranchUsage[] |
scope | UsageScope |
BudgetCheckResult
Properties
| Property | Type |
|---|---|
allowed | boolean |
reason? | string |
remaining_usd | number |
BundleUploadOptions
Properties
| Property | Type | Description |
|---|---|---|
fileName? | string | The upload's file name. Default rule.wasm. |
BundleUploadResult
Properties
| Property | Type |
|---|---|
accepted? | boolean |
gates? | object[] |
mode? | string |
ruleId? | string |
ChatMessage
Properties
| Property | Type |
|---|---|
content | string | any[] |
name? | string |
role | "system" | "user" | "assistant" | "tool" |
tool_call_id? | string |
tool_calls? | any[] |
ChatParams
Indexable
[key: string]: anyProperties
| Property | Type |
|---|---|
max_tokens? | number |
messages | ChatMessage[] |
model | string |
response_format? | any |
stream? | boolean |
temperature? | number |
tool_choice? | any |
tools? | any[] |
ChatResponse
Properties
| Property | Type | Description |
|---|---|---|
budgetPctUsed? | number | Deprecated Never set: the proxy does not report budget on responses. Use checkBudget(). |
budgetRemainingUsd? | number | Deprecated Never set: the proxy does not report budget on responses. Use checkBudget(). |
choices | object[] | - |
created | number | - |
id | string | - |
model | string | - |
object | string | - |
upstream? | UpstreamCalls | What the proxy's retry layer did, when it did anything: how many upstream calls this answer took, and — when a fallback answered after the model's retries ran out — which model failed (model names the one that answered). Absent for the ordinary single-call request. |
usage? | object | - |
usage.completion_tokens | number | - |
usage.prompt_tokens | number | - |
usage.total_tokens | number | - |
verdict? | Verdict | LegacyVerdict | Always allow: a response only comes back when the proxy let the request through. |
CheckDomainVerificationResult
Properties
| Property | Type |
|---|---|
domain | string |
status | "pending" | "verified" | "consumed" | "expired" |
txtRecordName | string |
txtRecordValue | string |
verificationId | string |
verifiedAt | string | null |
CircuitBreakerOptions
Properties
ClawdeClientOptions
Options for a ClawdeClient.
Properties
| Property | Type | Default value | Description |
|---|---|---|---|
apiKey | string | undefined | The key the proxy authenticates: an Intutic virtual key (vk_…) or a provider key. |
autoContext? | boolean | true | Resolve context (resolveContext()) and register a session carrying the repository, branch and commit on the first chat(). false does neither. |
baseUrl? | string | INTUTIC_BASE_URL, then http://localhost:4000 | The proxy's address. |
controlPlaneUrl? | string | INTUTIC_CONTROL_PLANE_URL, then Intutic's hosted control plane | Control-plane base URL used by checkBudget() and session registration (a different origin from baseUrl — see ControlPlaneClient). |
graphIdentity? | Partial<GraphIdentity> | undefined | This client's position in the agent graph. Omit and it is inherited from the environment, so a spawned agent is automatically a child of its spawner. Supply it when one process drives several logical agents and the environment cannot describe the shape. |
provider? | "openai" | "anthropic" | "google" | undefined | 'anthropic' sends chat() to the proxy's /v1/messages route, converting the request and the answer between the OpenAI and Anthropic shapes. Otherwise the request goes to /v1/chat/completions as it is. |
retries? | number | 2 | How many times a transport failure, a timeout or a 5xx answer is retried. |
timeout? | number | 30000 | How long one attempt may take, in milliseconds. |
CommitUsage
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
branch | string | null | - |
commit | string | null | - |
firstCallAt | string | - |
lastCallAt | string | - |
repo | string | null | - |
totalCostUsd | number | UsageTotals.totalCostUsd |
totalInputTokens | number | UsageTotals.totalInputTokens |
totalOutputTokens | number | UsageTotals.totalOutputTokens |
totalRawCostUsd | number | UsageTotals.totalRawCostUsd |
traceCount | number | UsageTotals.traceCount |
CommitUsageResponse
Properties
| Property | Type |
|---|---|
commits | CommitUsage[] |
scope | UsageScope |
CompleteLoopRunOptions
Properties
| Property | Type |
|---|---|
outcome? | "FAILED" | "SUCCEEDED" |
ConfigChain
Properties
ControlPlaneClientOptions
Options for a ControlPlaneClient.
Properties
CostPrediction
Properties
| Property | Type |
|---|---|
basedOnSamples | number |
confidence | "low" | "medium" | "high" |
estimatedCostUsd | number |
estimatedOutputTokens | number |
estimatedReasoningTokens | number | null |
inputTokens | number |
CreateOrgParams
Properties
| Property | Type | Description |
|---|---|---|
domain | string | - |
orgName | string | - |
region? | string | Gateway cell region ('us' |
verificationId | string | - |
CreateOrgResult
Properties
| Property | Type |
|---|---|
name | string |
orgId | string |
planTier | string |
region? | string |
teamId | string |
workspaceId | string |
DecisionReviewResult
Properties
| Property | Type | Description |
|---|---|---|
bypassWritten? | boolean | A short-lived bypass was written for the exact retried call. |
ok | boolean | - |
status | string | - |
DeviceDisconnect
Properties
| Property | Type |
|---|---|
createdAt | string |
disconnectId | string |
fingerprint | string |
harnesses | string[] |
hostname | string |
memberId | string | null |
reportedBy | string | null |
scope | "machine" | "harness" |
DuplicatesOptions
Properties
| Property | Type | Description |
|---|---|---|
minJaccard? | number | 0 to 1. |
EvidenceArchive
An evidence archive: the parts verification reads. Everything else is covered by the archive hash.
Indexable
[key: string]: unknownProperties
| Property | Type |
|---|---|
categories? | object[] |
collectedAt? | string |
formatVersion? | number |
frameworks? | object[] |
manifest? | object |
manifest.algorithm? | string |
manifest.archiveSha256? | string |
manifest.sections? | Record<string, string> |
manifest.unsignedReason? | string |
overallScore? | number | null |
periodEnd? | string |
periodStart? | string |
runId? | string |
signature? | EvidenceDetachedSignature | null |
EvidenceCollectOptions
Properties
| Property | Type | Description |
|---|---|---|
periodEnd? | string | - |
periodStart? | string | ISO 8601. |
EvidenceCollectResult
Properties
| Property | Type |
|---|---|
archive | EvidenceArchive |
artifactUrl | string | null |
runId | string |
signed | boolean |
signingKeyId? | string |
unsignedReason? | string |
EvidenceDetachedSignature
Properties
| Property | Type |
|---|---|
algorithm | string |
keyId | string |
preimageDomain | string |
value | string |
EvidenceVerification
Properties
| Property | Type | Description |
|---|---|---|
archiveHashMatches | boolean | - |
archiveSha256 | string | The recomputed whole-archive hash, and whether it equals manifest.archiveSha256. |
sectionMismatches | string[] | Manifest entries whose content does not hash to the recorded value, or that name nothing in the archive. |
sectionsChecked | number | - |
signature | EvidenceSignatureState | - |
signingKeyId | string | null | - |
unsignedReason | string | null | - |
verified | boolean | True only when the hashes match and a published key accepts the signature. |
ExtractDocumentResult
Properties
ExtractOptions
Properties
| Property | Type | Description |
|---|---|---|
llm? | boolean | Default true. False runs only the front-matter lift, with no model call. |
Finding
Properties
| Property | Type |
|---|---|
anomaly_kind | string | null |
confidence | number |
created_at | string |
detector_id | string |
disposition | string | null |
finding_id | string |
harness | string | null |
loop_run_id | string | null |
outcome | FindingOutcome | null |
outcome_at | string | null |
outcome_by | string | null |
outcome_note | string | null |
reason | string | null |
session_id | string | null |
severity | string | null |
shadowed | boolean |
trace_id | string | null |
FindingAdjudication
Properties
| Property | Type |
|---|---|
finding_id | string |
outcome | FindingOutcome |
FindingFilters
Properties
| Property | Type | Description |
|---|---|---|
detectorId? | string | - |
limit? | number | - |
unadjudicated? | boolean | Only findings nobody has ruled on. |
FindingStats
Properties
| Property | Type |
|---|---|
caveats | string[] |
detectors | object[] |
FrameworkCoverage
Indexable
[key: string]: unknownProperties
GateLiveness
Properties
| Property | Type |
|---|---|
gates | object[] |
windowHours | number |
Gateway
Properties
| Property | Type |
|---|---|
createdAt | string |
deploymentTarget | string |
gatewayId | string |
keyPrefix | string |
lastHeartbeatAt | string | null |
name | string |
proxyVersion | string | null |
revokedAt | string | null |
status | string |
GatewayConfigResult
Properties
GatewayConfigUpdate
Properties
| Property | Type |
|---|---|
requireProvisionedKey? | boolean |
requireVk? | boolean |
GatewayRegisterParams
Properties
| Property | Type |
|---|---|
deploymentTarget | "docker" | "kubernetes" | "bare_metal" |
name | string |
GatewayRegisterResult
Properties
| Property | Type | Description |
|---|---|---|
deploymentTarget | string | - |
gatewayId | string | - |
instructions | string | - |
name | string | - |
status | string | - |
token | string | Shown once — not retrievable again after this response. |
GatewayResolution
Properties
| Property | Type |
|---|---|
gateway | | { deploymentTarget: string; gatewayId: string; name: string; status: string; } | null |
source | "workspace" | "org" | "default" |
staleAssignment? | string |
GatewayRotateResult
Properties
| Property | Type | Description |
|---|---|---|
gatewayId | string | - |
instructions | string | - |
previousTokenValidUntil | string | - |
token | string | Shown once — not retrievable again after this response. |
GatewayStatus
Properties
GitHubWebhookInfo
Properties
| Property | Type |
|---|---|
configured | boolean |
createdAt | string | null |
lastDeliveryAt | string | null |
secretRotatedAt | string | null |
url | string | null |
GitHubWebhookSecret
Properties
| Property | Type | Description |
|---|---|---|
secret | string | Shown once: not retrievable again after this response. |
url | string | - |
GuardrailConflict
Properties
| Property | Type |
|---|---|
a | object |
a.id | string |
a.quote | string |
b | object |
b.id | string |
b.quote | string |
detail | string |
kind | string |
token | string | null |
GuardrailDeleteResult
Properties
| Property | Type |
|---|---|
guardrail | GuardrailDetail |
ok | boolean |
GuardrailDetail
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
clause | Record<string, unknown> | null | - | GuardrailSummary.clause |
description | string | null | - | GuardrailSummary.description |
document | | { docId: string; provider: string; sourceUrl: string | null; title: string; } | null | - | GuardrailSummary.document |
enforcingFires | number | - | GuardrailSummary.enforcingFires |
events | object[] | - | - |
guardrailId | string | - | GuardrailSummary.guardrailId |
ir | Record<string, unknown> | The guardrail IR: kind and the keys that kind takes. | GuardrailSummary.ir |
name | string | null | - | GuardrailSummary.name |
passage | Record<string, unknown> | null | - | - |
promotedAt | string | null | - | GuardrailSummary.promotedAt |
proposedAt | string | - | GuardrailSummary.proposedAt |
provenance | GuardrailProvenance | - | GuardrailSummary.provenance |
rejectedReason | string | null | - | GuardrailSummary.rejectedReason |
rendered | unknown | - | GuardrailSummary.rendered |
roles | string[] | - | GuardrailSummary.roles |
ruleCandidateId | string | null | - | GuardrailSummary.ruleCandidateId |
scope | string | - | GuardrailSummary.scope |
shadowAt | string | null | - | GuardrailSummary.shadowAt |
shadowEvaluations | number | - | GuardrailSummary.shadowEvaluations |
shadowWouldAct | number | - | GuardrailSummary.shadowWouldAct |
sourceStale | boolean | - | GuardrailSummary.sourceStale |
status | GuardrailStatus | - | GuardrailSummary.status |
supersededBy | string | null | - | - |
supersedes | string | null | - | GuardrailSummary.supersedes |
target | GuardrailTarget | - | GuardrailSummary.target |
validation | unknown | - | - |
version | number | - | GuardrailSummary.version |
GuardrailFilters
Properties
| Property | Type |
|---|---|
docId? | string |
limit? | number |
provenance? | GuardrailProvenance |
status? | GuardrailStatus |
target? | GuardrailTarget |
GuardrailImpactSeed
Name exactly one: the document or the passage whose change to follow.
Properties
| Property | Type |
|---|---|
docId? | string |
passageId? | string |
GuardrailReadiness
Properties
GuardrailReplay
Properties
| Property | Type |
|---|---|
captured | number |
fires | number |
sample | object[] |
source | "enforcement_log" | "context_snapshots" | "execution_traces" | "none" |
truncated | boolean |
unsupported | string[] |
windowDays | number |
GuardrailSummary
Extended by
Properties
| Property | Type | Description |
|---|---|---|
clause | Record<string, unknown> | null | - |
description | string | null | - |
document | | { docId: string; provider: string; sourceUrl: string | null; title: string; } | null | - |
enforcingFires | number | - |
guardrailId | string | - |
ir | Record<string, unknown> | The guardrail IR: kind and the keys that kind takes. |
name | string | null | - |
promotedAt | string | null | - |
proposedAt | string | - |
provenance | GuardrailProvenance | - |
rejectedReason | string | null | - |
rendered | unknown | - |
roles | string[] | - |
ruleCandidateId | string | null | - |
scope | string | - |
shadowAt | string | null | - |
shadowEvaluations | number | - |
shadowWouldAct | number | - |
sourceStale | boolean | - |
status | GuardrailStatus | - |
supersedes | string | null | - |
target | GuardrailTarget | - |
version | number | - |
GuardrailTransitionResult
Properties
| Property | Type | Description |
|---|---|---|
guardrail | GuardrailDetail | The guardrail as the transition left it. |
ok | boolean | - |
readiness? | GuardrailReadiness | - |
Incident
One governance incident, with the route's snake_case keys.
Properties
IncidentFilters
Properties
IncidentList
listProperty and rowCase, which every control-plane list response carries beside its rows.
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
data | Incident[] | Ranked by review priority, not time. A list of 20 or more arrives TOON-encoded and is decoded here, with each cell cut at 120 characters: getIncident has the whole description. | - |
listProperty? | string | - | ListEnvelope.listProperty |
meta | object | - | - |
meta.audit | object | The review budget: how many of the matching incidents the ranked queue covers. | - |
meta.audit.budget | number | - | - |
meta.audit.matched | number | - | - |
meta.audit.overBudget | boolean | - | - |
meta.audit.withheld | number | - | - |
meta.limit | number | - | - |
meta.page | number | - | - |
meta.total | number | - | - |
rowCase? | "snake" | "camel" | "mixed" | - | ListEnvelope.rowCase |
IntegrityChain
The walk is the answer whether or not it found a break (the control plane answers a break with a 409).
Properties
| Property | Type |
|---|---|
breaks | object[] |
intact | boolean |
ok | boolean |
rootsNotWalked | number |
rootsWalked | number |
unchainedRootIds | string[] |
workspaceId | string |
IntegrityRecompute
Properties
| Property | Type |
|---|---|
changedTraceIds | string[] |
missingTraceIds | string[] |
ok | boolean |
recomputedRoot | string | null |
retentionExpired? | boolean |
storedRoot | string |
verdict | "match" | "mismatch" | "missing_traces" |
IntegrityRootDetail
Properties
| Property | Type |
|---|---|
leaves | object[] |
ok | boolean |
root | SealedRoot & SignedIntegrityRoot & object |
IntegrityRootList
listProperty and rowCase, which every control-plane list response carries beside its rows.
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
data | SealedRoot[] | - |
leafSchemaVersion | number | - |
listProperty? | string | ListEnvelope.listProperty |
ok | boolean | - |
rowCase? | "snake" | "camel" | "mixed" | ListEnvelope.rowCase |
InventoryDevice
Properties
InventoryFilters
Properties
| Property | Type | Description |
|---|---|---|
device? | string | A device id. |
harness? | string | - |
search? | string | Text matched against the item's name and the machine's hostname. |
status? | string | - |
InventoryHarness
Extends
InventoryItem
Properties
InventoryMcpServer
Extends
InventoryItem
Properties
InventorySkill
Extends
InventoryItem
Properties
InventorySkillFilters
Properties
| Property | Type |
|---|---|
device? | string |
search? | string |
InventorySummary
Properties
LedgerDuplicates
Properties
| Property | Type |
|---|---|
minJaccard | number |
passagePairs | Record<string, unknown>[] |
sameRule | Record<string, unknown>[] |
LedgerImpact
Properties
| Property | Type |
|---|---|
clauses | Record<string, unknown>[] |
guardrails | object[] |
maxDepth | number |
passages | Record<string, unknown>[] |
seed | object |
seed.docId | string | null |
seed.passageId | string | null |
truncated | boolean |
ListEnvelope
listProperty and rowCase, which every control-plane list response carries beside its rows.
Extended by
Properties
| Property | Type |
|---|---|
listProperty? | string |
rowCase? | "snake" | "camel" | "mixed" |
LoopRun
Indexable
[key: string]: unknownProperties
| Property | Type |
|---|---|
budgetLimitUsd | string |
loopRunId | string |
name | string |
status | LoopRunStatus |
totalTokenCostUsd | string |
LoopRunActionResult
Properties
| Property | Type |
|---|---|
ok | boolean |
outcome? | string |
status? | string |
LoopRunReviewOptions
Properties
| Property | Type |
|---|---|
note? | string |
McpServer
Properties
McpServerDecision
Properties
| Property | Type |
|---|---|
ok | boolean |
server | McpServer |
McpServerList
listProperty and rowCase, which every control-plane list response carries beside its rows.
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
defaultPolicy | "allow" | "deny" | - |
highRiskToolChange | "hold" | "notify" | - |
listProperty? | string | ListEnvelope.listProperty |
pendingCount | number | - |
rowCase? | "snake" | "camel" | "mixed" | ListEnvelope.rowCase |
servers | McpServer[] | - |
MemberUsage
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
activeDays | number | - | - |
displayName | string | null | - | - |
email | string | null | - | - |
memberId | string | null | Null for calls no single member owns. | - |
models | string[] | - | - |
totalCostUsd | number | - | UsageTotals.totalCostUsd |
totalInputTokens | number | - | UsageTotals.totalInputTokens |
totalOutputTokens | number | - | UsageTotals.totalOutputTokens |
totalRawCostUsd | number | - | UsageTotals.totalRawCostUsd |
traceCount | number | - | UsageTotals.traceCount |
MemberUsageResponse
Properties
| Property | Type |
|---|---|
members | MemberUsage[] |
scope | UsageScope |
NotificationChannelConfig
Properties
| Property | Type |
|---|---|
emailRecipients? | string[] |
pagerdutyRoutingKey? | string |
slackChannelId? | string |
slackChannelName? | string |
webhookUrl? | string |
NotificationFilters
Properties
| Property | Type |
|---|---|
harnessType? | string[] |
severity? | string[] |
userId? | string[] |
NotificationRule
Properties
| Property | Type | Description |
|---|---|---|
channel | NotificationChannel | - |
channelConfig | NotificationChannelConfig | - |
cooldownMinutes | number | - |
enabled | boolean | - |
eventType | string | - |
filters | NotificationFilters | - |
ruleId | string | - |
signingSecret? | string | A webhook rule's signing secret, only in the response that made it. Not retrievable again. |
NotificationRuleInput
The body of a create. Channel config and filters are each stored whole.
Properties
| Property | Type |
|---|---|
channel | NotificationChannel |
channelConfig | NotificationChannelConfig |
cooldownMinutes? | number |
enabled? | boolean |
eventType | string |
filters? | NotificationFilters |
NotificationSecretRotation
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
ruleId | string | - | - |
signingSecret | string | Shown once: not retrievable again after this response. | SigningSecretRotation.signingSecret |
OrgSignupParams
Properties
| Property | Type |
|---|---|
email | string |
name | string |
orgName | string |
password | string |
OrgSignupResult
Properties
OrgSop
Indexable
[key: string]: unknownProperties
| Property | Type |
|---|---|
createdAt | string |
orgId? | string |
orgSopId | string |
riskTier | string |
title | string |
OrgSopInput
Properties
| Property | Type |
|---|---|
markdown_content | string |
risk_tier? | string |
title | string |
PassageSearchResult
Properties
| Property | Type |
|---|---|
passages | object[] |
query | string |
PolicyDocumentDetail
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
clauseCount | number | PolicyDocumentSummary.clauseCount |
clauses | Record<string, unknown>[] | - |
contentHash | string | - |
docId | string | PolicyDocumentSummary.docId |
fetchedAt | string | PolicyDocumentSummary.fetchedAt |
guardrailCount | number | PolicyDocumentSummary.guardrailCount |
injectionFlagged | boolean | PolicyDocumentSummary.injectionFlagged |
lastRun | | { error: string | null; extractor: string; finishedAt: string | null; runId: string; startedAt: string; } | null | PolicyDocumentSummary.lastRun |
passageCount | number | PolicyDocumentSummary.passageCount |
passages | Record<string, unknown>[] | - |
provider | string | PolicyDocumentSummary.provider |
runs | Record<string, unknown>[] | - |
sopId | string | null | PolicyDocumentSummary.sopId |
sourceUrl | string | null | PolicyDocumentSummary.sourceUrl |
status | string | PolicyDocumentSummary.status |
title | string | PolicyDocumentSummary.title |
upstreamVersion | string | null | - |
PolicyDocumentSummary
Extended by
Properties
PolicySource
Properties
| Property | Type |
|---|---|
config | Record<string, unknown> | null |
connector_id | string |
created_at? | string |
last_attempt_at? | string | null |
last_sync_error? | string | null |
last_synced_at | string | null |
name | string |
provider | PolicySourceProvider |
PolicySourceInput
Properties
| Property | Type | Description |
|---|---|---|
config? | Record<string, unknown> | - |
name | string | - |
provider | PolicySourceProvider | - |
token | string | The provider credential (a Google service-account key is the key file's JSON). |
PolicySourceSyncResult
Properties
| Property | Type |
|---|---|
processed_docs | number |
success | boolean |
successor_sops | string[] |
updated_sops | string[] |
PredictCostParams
Properties
| Property | Type | Description |
|---|---|---|
inputText? | string | - |
inputTokenCount? | number | - |
model | string | - |
workspaceId | string | Must be the key's own workspace. |
PromoteOptions
Properties
| Property | Type | Description |
|---|---|---|
acknowledgeNoTraffic? | boolean | Promote a guardrail that never fired in shadow. Default false. |
ProviderCredentialStatus
Properties
| Property | Type |
|---|---|
lastFour | string | null |
provider | string |
provisioned | boolean |
routingLive | boolean |
updatedAt | string | null |
ProviderModelList
The models a provider credential can reach, as the provider listed them when the stored key was last checked. models and checkedAt are null until a check has recorded a list (and stay so for providers that have no list, such as Azure OpenAI, whose list names base models, not deployments).
Properties
| Property | Type |
|---|---|
checkedAt | string | null |
models | string[] | null |
provider | string |
ProxyRefusal
Properties
| Property | Type | Description |
|---|---|---|
code | string | - |
message | string | - |
ruleId? | string | The rule that decided, for a refusal the proxy answered in band. |
verdict | RefusalVerdict | - |
PullRequestRefreshResult
Properties
| Property | Type |
|---|---|
checked | number |
noAccess | number |
notModified | number |
pullRequests | number |
rateLimited | boolean |
PullRequestSources
Properties
| Property | Type |
|---|---|
apiHost | string |
connector | boolean |
lastCheckedAt | string | null |
mappedPullRequests | number |
noAccessRepos | string[] |
webhook | boolean |
PullRequestUsage
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
author | string | null | - |
baseBranch | string | null | - |
closedAt | string | null | - |
firstCallAt | string | - |
headBranch | string | - |
lastCallAt | string | - |
memberCount | number | - |
mergedAt | string | null | - |
number | number | - |
openedAt | string | - |
repo | string | - |
state | "open" | "closed" | "merged" | - |
title | string | - |
totalCostUsd | number | UsageTotals.totalCostUsd |
totalInputTokens | number | UsageTotals.totalInputTokens |
totalOutputTokens | number | UsageTotals.totalOutputTokens |
totalRawCostUsd | number | UsageTotals.totalRawCostUsd |
traceCount | number | UsageTotals.traceCount |
url | string | - |
PullRequestUsageResponse
Properties
| Property | Type |
|---|---|
github | PullRequestSources |
pullRequests | PullRequestUsage[] |
scope | UsageScope |
ResolvedContext
Properties
| Property | Type |
|---|---|
ciPipeline? | string |
gitBranch? | string |
jiraTicket? | string |
pagerdutyIncident? | string |
sessionId? | string |
workingDirectory? | string |
workspaceId? | string |
ResponseEchoReport
Properties
| Property | Type |
|---|---|
patterns | object[] |
refusal | string | null |
tracesIngested | number |
window | object |
window.since | string |
window.until | string |
ResponseEchoReportOptions
Properties
| Property | Type | Description |
|---|---|---|
since? | string | ISO 8601. |
until? | string | - |
ReviewOptions
Properties
| Property | Type | Description |
|---|---|---|
reason? | string | Recorded with the decision. |
RuleCandidateSource
Properties
| Property | Type | Description |
|---|---|---|
candidateId | string | - |
guardrailId | string | null | - |
source | string | - |
sourceSha256 | string | Lower-case hex; checked against source before it is returned. |
status | string | - |
SealedRoot
Properties
SiemDestination
Properties
| Property | Type | Description |
|---|---|---|
adapterType | SiemAdapterType | - |
batchSize | number | - |
config? | Record<string, unknown> | The adapter settings, with credentials masked. |
destinationId | string | - |
flushIntervalMs | number | - |
isActive | boolean | - |
lastError? | string | null | Absent on the create response, which reports no health yet. |
lastHeartbeatAt? | string | null | Absent on the create response, which reports no health yet. |
name | string | - |
signingSecret? | string | A webhook destination's signing secret, only in the response that made it. |
sourceTables | string[] | Empty means the default set: every source except the opt-in ones. |
SiemDestinationInput
Properties
| Property | Type | Description |
|---|---|---|
adapterType | SiemAdapterType | - |
batchSize? | number | - |
config | Record<string, unknown> | Adapter settings, credentials included; the control plane encrypts them and masks them on every read. |
flushIntervalMs? | number | - |
name | string | - |
sourceTables? | string[] | - |
SiemDestinationList
Properties
| Property | Type |
|---|---|
items | SiemDestinationSummary[] |
sources | SiemSources |
SiemDestinationUpdate
Properties
SiemSecretRotation
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
destinationId | string | - | - |
signingSecret | string | Shown once: not retrievable again after this response. | SigningSecretRotation.signingSecret |
SiemSources
Properties
| Property | Type |
|---|---|
all | string[] |
defaults | string[] |
SignedIntegrityRoot
The fields of a sealed root its signature covers, as GET /api/v1/integrity/roots/:rootId serves them: what verifyIntegrityRoot reads.
Properties
SigningJwks
The control plane's published signing keys, one per kid.
Properties
| Property | Type |
|---|---|
keys | Record<string, unknown>[] |
SigningSecretRotation
Extended by
Properties
| Property | Type | Description |
|---|---|---|
signingSecret | string | Shown once: not retrievable again after this response. |
SopCreateResult
The created SOP: POST /api/v1/sops answers with the SOP itself (it sends no ok).
Properties
| Property | Type |
|---|---|
complexityTier | string |
isActive | boolean |
lifecycleState | string |
markdownContent | string |
riskTier | string |
sopId | string |
title | string |
version | string |
workspaceId | string |
SopDetail
Indexable
[key: string]: unknownProperties
| Property | Type | Description |
|---|---|---|
markdownContent | string | - |
riskTier | string | null | Null for a SOP stored without one. |
sopId | string | - |
title | string | - |
version | string | - |
SopInput
The body intutic sops push sends, in the route's snake_case.
Properties
| Property | Type |
|---|---|
complexity_tier? | string |
markdown_content | string |
risk_tier? | string |
title | string |
version? | string |
SopSummary
Indexable
[key: string]: unknownProperties
| Property | Type |
|---|---|
contentHash? | string |
sopId | string |
title | string |
StartDomainVerificationResult
Properties
| Property | Type |
|---|---|
domain | string |
expiresAt | string |
txtRecordName | string |
txtRecordValue | string |
verificationId | string |
StartLoopRunOptions
Properties
| Property | Type | Description |
|---|---|---|
autoJudge? | boolean | - |
budgetLimitUsd? | string | number | - |
sops? | string[] | SOP names active for the run. |
Team
Properties
| Property | Type |
|---|---|
createdAt | string |
name | string |
orgId | string |
slug | string |
teamId | string |
TeamUsage
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
activeMembers | number | - |
displayName | string | - |
groupId | string | - |
memberCount | number | - |
totalCostUsd | number | UsageTotals.totalCostUsd |
totalInputTokens | number | UsageTotals.totalInputTokens |
totalOutputTokens | number | UsageTotals.totalOutputTokens |
totalRawCostUsd | number | UsageTotals.totalRawCostUsd |
traceCount | number | UsageTotals.traceCount |
TeamUsageResponse
Properties
| Property | Type | Description |
|---|---|---|
scimGroups | boolean | False when the workspace has no SCIM groups, so there are no teams. |
teams | TeamUsage[] | - |
TokenCoverage
Properties
| Property | Type |
|---|---|
guardrails | object[] |
passages | object[] |
token | string |
TraceDetail
Indexable
[key: string]: unknownProperties
| Property | Type |
|---|---|
actualCostUsd | number |
actualModelRouted | string |
enforcementAction | string |
requestedModel | string |
requestId | string |
sessionId | string |
timestamp | string |
traceId | string |
TraceFilters
Properties
TraceList
listProperty and rowCase, which every control-plane list response carries beside its rows.
Extends
Properties
| Property | Type | Inherited from |
|---|---|---|
limit? | number | - |
listProperty? | string | ListEnvelope.listProperty |
offset? | number | - |
rowCase? | "snake" | "camel" | "mixed" | ListEnvelope.rowCase |
total | number | - |
traces | TraceSummary[] | - |
TraceSummary
Properties
UpstreamCalls
The proxy's x-intutic-upstream-attempts / x-intutic-upstream-fallback-from headers, read.
Properties
| Property | Type |
|---|---|
attempts | number |
fallbackFrom? | string |
UsageOptions
Properties
| Property | Type | Description |
|---|---|---|
period? | UsagePeriod | Default monthly. |
UsageTotals
Extended by
Properties
| Property | Type |
|---|---|
totalCostUsd | number |
totalInputTokens | number |
totalOutputTokens | number |
totalRawCostUsd | number |
traceCount | number |
WasmReplayOptions
Properties
| Property | Type | Description |
|---|---|---|
limit? | number | - |
since? | string | ISO 8601. |
WasmReplayResult
Properties
| Property | Type |
|---|---|
contextCount | number |
ruleId | string |
sampleMatches | Record<string, unknown>[] |
since | string | null |
verdictCounts | Record<string, number> |
wouldActCount | number |
wouldActRate | number |
WhoamiResult
Properties
| Property | Type |
|---|---|
email | string |
memberId | string |
role | string |
workspaceId | string |
Workspace
Properties
| Property | Type |
|---|---|
createdAt | string |
name | string |
planTier | string |
slug | string |
workspaceId | string |
WorkspaceSettings
Extended by
Properties
| Property | Type | Description |
|---|---|---|
settings | Record<string, unknown> | Every setting, resolved with its default. |
workspaceId | string | - |
WorkspaceSettingsUpdateResult
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
settings | Record<string, unknown> | Every setting, resolved with its default. | WorkspaceSettings.settings |
updated | true | - | - |
workspaceId | string | - | WorkspaceSettings.workspaceId |
Type Aliases
CoverageFormat
type CoverageFormat = "json" | "md" | "csv" | "pdf";The coverage report formats: md is markdown.
EventCallback
type EventCallback = (data) => void | Promise<void>;Called with the refusal before chat() throws it as a ClawdeBlockedError.
Parameters
| Parameter | Type | Description |
|---|---|---|
data | { budgetPctUsed?: number; budgetRemainingUsd?: number; code: string; message: string; ruleId?: string; status: number; verdict: Verdict | LegacyVerdict; } | - |
data.budgetPctUsed? | number | Deprecated Never set. |
data.budgetRemainingUsd? | number | Deprecated Never set. |
data.code | string | The proxy's refusal code, e.g. policy_denied, OVERAGE_HARD_CAP_EXCEEDED or TOOL_DENIED. |
data.message | string | - |
data.ruleId? | string | The rule that decided, when the proxy names one. |
data.status | number | - |
data.verdict | Verdict | LegacyVerdict | One of the RefusalVerdict values; typed wider so listeners written against 2.0 compile. |
Returns
void | Promise<void>
EvidenceSignatureState
type EvidenceSignatureState = "valid" | "invalid" | "unsigned" | "unverifiable" | "keys_unavailable";FindingOutcome
type FindingOutcome = "TRUE_POSITIVE" | "FALSE_POSITIVE";GuardrailProvenance
type GuardrailProvenance = "extracted" | "authored";GuardrailStatus
type GuardrailStatus = "PROPOSED" | "SHADOW" | "ENFORCING" | "REJECTED" | "RETIRED";GuardrailTarget
type GuardrailTarget = "hook_rule" | "sop_front_matter" | "wasm_rule" | "workspace_setting";IntegrityRootSignatureState
type IntegrityRootSignatureState = "valid" | "invalid" | "unsigned" | "unverifiable" | "keys_unavailable";What verifyIntegrityRoot established: valid a published key accepted the signature, invalid the key the root names rejected it, unsigned no key was configured when it was sealed, unverifiable the key is not published or the root names an algorithm or preimage version this build cannot check, keys_unavailable no key set was given. Only invalid says the root changed.
LegacyVerdict
type LegacyVerdict = "hijack" | "enhance" | "bypass";Deprecated
Never reported. The proxy applies these inside the response and does not tell the client, so no response carries them and no event fires for them. Still accepted so code written against 2.0 compiles; they will be removed in the next major version.
LoopRunStatus
type LoopRunStatus = "ACTIVE" | "PENDING_REVIEW" | "COMPLETED" | "FAILED" | "KILLED";MirrorAdoptionReport
type MirrorAdoptionReport =
| {
averageCostDeltaUsd: number | null;
averageLatencyDeltaMs: number | null;
candidateBetter: number;
candidateModel: string;
faultRateDelta: number | null;
originalBetter: number;
sampleCount: number;
sufficientData: true;
tie: number;
unjudged: number;
}
| {
candidateModel: string;
minimumRequired: number;
reason: string;
sampleCount: number;
sufficientData: false;
};NotificationChannel
type NotificationChannel = "slack" | "email" | "webhook" | "pagerduty";NotificationRuleUpdate
type NotificationRuleUpdate = Partial<NotificationRuleInput>;An update sends only the fields that change; channelConfig and filters replace the stored ones whole.
PolicySourceProvider
type PolicySourceProvider = "notion" | "confluence" | "github" | "gdrive";The connector providers that are policy sources.
RefusalVerdict
type RefusalVerdict = "kill" | "reask" | "hold";A governance refusal the proxy answered with: kill blocks the request, reask refuses this attempt and tells the agent to revise it (it escalates to kill after repeated attempts), and hold pauses a loop run until a human reviews it.
SiemAdapterType
type SiemAdapterType =
| "syslog_cef"
| "webhook_https"
| "gcs"
| "s3"
| "splunk_hec"
| "datadog_logs";SiemDestinationSummary
type SiemDestinationSummary = Omit<SiemDestination, "config" | "signingSecret">;A destination as the list answers it: no adapter settings, and no signing secret.
UsagePeriod
type UsagePeriod = "daily" | "monthly";UsageScope
type UsageScope = "workspace" | "self";self when the caller may see only their own calls (below OWNER, ADMIN and EM).
Verdict
type Verdict = "allow" | RefusalVerdict;What chat() can know about a request: it was let through, or refused.
VerdictEvent
type VerdictEvent = RefusalVerdict | LegacyVerdict;Events on() accepts.
Variables
PROXY_REFUSALS
const PROXY_REFUSALS: Readonly<Record<string, {
status: number;
verdict: RefusalVerdict;
}>>;The proxy's governance refusals, by code, with the status the proxy sends each with and the verdict it represents.
Most arrive as an error: the code is the error.type of the proxy's JSON error body ({"error": {"type", "message"}}, json_error in packages/proxy/src/proxy.rs). Matching on the status and the code together matters because the same statuses also carry errors that are not decisions: a provider's own 429 rate limit, a 403 for a key used against the wrong workspace, a 400 for a malformed body. Those are not refusals and must not be reported as one.
The rest (status 200, and COST_GATE_EXCEEDED on a non-streaming request) arrive in band: an assistant turn explaining the refusal, named by REFUSAL_HEADER, or on a stream by the STREAM_REFUSAL_MARKER comment line.
__tests__/refusals.test.ts holds this table to packages/shared-types/fixtures/refusal-codes.json, the one list the proxy and the Python SDK are held to as well, so a refusal the proxy adds or renames fails the build instead of silently turning back into an allow or a retried connection error.
REFUSAL_HEADER
const REFUSAL_HEADER: "x-intutic-refusal" = 'x-intutic-refusal';The headers the proxy sets on a 200 that is a refusal in the shape of an answer: the response gate withheld a tool call the model made, output DLP withheld the body, or the cost-prediction gate answered instead of the model. The first names the refusal's code, the second the rule that decided.
REFUSAL_RULE_HEADER
const REFUSAL_RULE_HEADER: "x-intutic-refusal-rule" = 'x-intutic-refusal-rule';STREAM_REFUSAL_MARKER
const STREAM_REFUSAL_MARKER: ": intutic-refusal " = ': intutic-refusal ';The prefix of the SSE comment line that names a refusal on a stream: : intutic-refusal {"code", "rule", "message"}. The response headers went out before the refusal happened, so a stream says it in band; every SSE parser skips comment lines, so clients that do not look for it are unaffected.
UPSTREAM_ATTEMPTS_HEADER
const UPSTREAM_ATTEMPTS_HEADER: "x-intutic-upstream-attempts" = 'x-intutic-upstream-attempts';Set by the proxy when its retry layer made more than one upstream call.
UPSTREAM_FALLBACK_HEADER
const UPSTREAM_FALLBACK_HEADER: "x-intutic-upstream-fallback-from" = 'x-intutic-upstream-fallback-from';Set by the proxy when a fallback answered: the model whose retries ran out.
Functions
normalizeRequest()
function normalizeRequest(params, provider?): any;Parameters
| Parameter | Type |
|---|---|
params | ChatParams |
provider? | string |
Returns
any
normalizeResponse()
function normalizeResponse(response, provider?): ChatResponse;Parameters
| Parameter | Type |
|---|---|
response | any |
provider? | string |
Returns
resolveContext()
function resolveContext(): Promise<ResolvedContext>;Each field comes from ~/.intutic/config.json when that file carries it, and from the environment otherwise. The file intutic init writes holds none of these fields, so reading it must not hide the environment.
Returns
Promise<ResolvedContext>
streamRefusal()
function streamRefusal(text): ProxyRefusal | null;The refusal named anywhere in a stream's text, or null when there is none. Pass the whole body, or each line as it arrives.
Parameters
| Parameter | Type |
|---|---|
text | string |
Returns
ProxyRefusal | null
verifyEvidenceArchive()
function verifyEvidenceArchive(archive, jwks): EvidenceVerification;Checks an evidence archive the way it was sealed: the manifest's hashes, then the signature over the archive hash against the published key its keyId names (jwks, from ControlPlaneClient.getSigningKeys() or a saved copy; null when it could not be had).
verified is true only for an archive whose hashes match and whose signature a published key accepts. An unsigned archive, or one whose key is not published, is not verified even when its hashes match: nothing then shows who produced it.
Parameters
| Parameter | Type |
|---|---|
archive | EvidenceArchive |
jwks | SigningJwks | null |
Returns
verifyIntegrityRoot()
function verifyIntegrityRoot(root, jwks): IntegrityRootSignatureState;Checks a sealed root's signature against the published key the root itself names (jwks, from ControlPlaneClient.getSigningKeys() or a saved copy; null when it could not be had). Pass the root of ControlPlaneClient.getIntegrityRoot().
Only invalid says the root was changed: a published key rejected it. unverifiable (the key is not published, or the root names an algorithm or preimage version this build cannot check) and keys_unavailable are no verdict, and unsigned is a deployment that had no signing key. The key is chosen by signing_key_id and never by trying others: a root that verifies under some other key is not the same claim.
Parameters
| Parameter | Type |
|---|---|
root | SignedIntegrityRoot |
jwks | SigningJwks | null |