Platform API ClientClient group10 methodsRiskMethods

Risk

Evaluate runtime decisions, fetch routing configuration, and inspect deterministic risk decisions for each run.

Runtime scoringRouter configurationDecision history

Risk

risk.evaluate()

Curated exampleHTTP endpoint wrapperPOST /api/v1/risk/evaluate

POST /api/v1/risk/evaluate

Signature

evaluate(input: RuntimeRiskInput): Promise<RiskEvaluationResponse>

Parameters

Name	Type	Flags
input	RuntimeRiskInput	required

TypeScript SDKTypeScript

const decision = await client.risk.evaluate({
  runId: "run_checkout_001",
  policyDecisions: [
    { policyId: "route-eu", decision: "allow" },
    { policyId: "pii-guard", decision: "warn" },
  ],
  quotaState: { usageRatio: 0.34 },
  evaluationSignals: [
    { name: "latency", severity: "low", value: 380 },
    { name: "data_classification", severity: "high", value: "pii" },
  ],
});

console.log(decision.action, decision.score);

Response

{
  "id": "risk_01JAZ3QPW6KX3P6AYM3FRT6DKE",
  "runId": "run_checkout_001",
  "action": "flag",
  "score": 0.41,
  "factors": [...],
  "deterministicInputsHash": "6cf63b..."
}

risk.getConfig()

Generated exampleHTTP endpoint wrapperGET /api/v1/risk/config

GET /api/v1/risk/config

Signature

getConfig(): Promise<RiskRouterConfig>

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const response = await client.risk.getConfig();
console.log(response);

Response

// Response type
Promise<RiskRouterConfig>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.updateConfig()

Generated exampleHTTP endpoint wrapperPUT /api/v1/risk/config

PUT /api/v1/risk/config

Signature

updateConfig(config: RiskRouterConfig): Promise<RiskRouterConfig>

Parameters

Name	Type	Flags
config	RiskRouterConfig	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const config = {} as RiskRouterConfig;
// Fill the config payload fields before calling this method.

const response = await client.risk.updateConfig(config);
console.log(response);

Response

// Response type
Promise<RiskRouterConfig>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.listDecisions()

Generated exampleHTTP endpoint wrapperGET /api/v1/risk/decisions

GET /api/v1/risk/decisions

Signature

listDecisions(params?: ListDecisionsParams): Promise<ListDecisionsResponse>

Parameters

Name	Type	Flags
params	ListDecisionsParams	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const params = {} as ListDecisionsParams;
// Fill the params payload fields before calling this method.

const response = await client.risk.listDecisions(params);
console.log(response);

Response

// Response type
Promise<ListDecisionsResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.simulate()

Generated exampleHTTP endpoint wrapperPOST /api/v1/risk/simulate

POST /api/v1/risk/simulate

Signature

simulate(input: RiskSimulateInput): Promise<RiskSimulateResponse>

Parameters

Name	Type	Flags
input	RiskSimulateInput	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as RiskSimulateInput;
// Fill the input payload fields before calling this method.

const response = await client.risk.simulate(input);
console.log(response);

Response

// Response type
Promise<RiskSimulateResponse>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.getConfigVersions()

Generated exampleHTTP endpoint wrapperGET /api/v1/risk/config/versions

GET /api/v1/risk/config/versions

Signature

getConfigVersions(): Promise<{ data: RiskConfigVersionRecord[]; activeVersion: number }>

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const response = await client.risk.getConfigVersions();
console.log(response);

Response

// Response type
Promise<{ data: RiskConfigVersionRecord[]; activeVersion: number }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.saveDraft()

Generated exampleHTTP endpoint wrapperPOST /api/v1/risk/config/draft

POST /api/v1/risk/config/draft

Signature

saveDraft(input: RiskConfigDraftInput): Promise<{
    draft: true;
    config: RiskRouterConfig;
    changeSummary?: string;
    savedAt: string;
  }>

Parameters

Name	Type	Flags
input	RiskConfigDraftInput	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as RiskConfigDraftInput;
// Fill the input payload fields before calling this method.

const response = await client.risk.saveDraft(input);
console.log(response);

Response

// Response type
Promise<{
    draft: true;
    config: RiskRouterConfig;
    changeSummary?: string;
    savedAt: string;
  }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.clearDraft()

Generated exampleHTTP endpoint wrapperDELETE /api/v1/risk/config/draft

DELETE /api/v1/risk/config/draft

Signature

clearDraft(): Promise<{ cleared: true }>

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const response = await client.risk.clearDraft();
console.log(response);

Response

// Response type
Promise<{ cleared: true }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.publishDraft()

Generated exampleHTTP endpoint wrapperPOST /api/v1/risk/config/publish

POST /api/v1/risk/config/publish

Signature

publishDraft(input?: { changeSummary?: string }): Promise<RiskConfigVersionRecord>

Parameters

Name	Type	Flags
input	{ changeSummary?: string }	optional

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as { changeSummary?: string };
// Fill the input payload fields before calling this method.

const response = await client.risk.publishDraft(input);
console.log(response);

Response

// Response type
Promise<RiskConfigVersionRecord>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));

risk.rollbackConfig()

Generated exampleHTTP endpoint wrapperPOST /api/v1/risk/config/rollback

POST /api/v1/risk/config/rollback

Signature

rollbackConfig(input: RiskConfigRollbackInput): Promise<RiskConfigVersionRecord & { rolledBackFrom: number }>

Parameters

Name	Type	Flags
input	RiskConfigRollbackInput	required

TypeScript SDKTypeScript

import { ArelisClient } from "@arelis-ai/governance-api-client";

const client = new ArelisClient({
  baseUrl: "https://api.arelis.digital",
  apiKey: process.env.ARELIS_API_KEY,
});

const input = {} as RiskConfigRollbackInput;
// Fill the input payload fields before calling this method.

const response = await client.risk.rollbackConfig(input);
console.log(response);

Response

// Response type
Promise<RiskConfigVersionRecord & { rolledBackFrom: number }>

// Inspect concrete fields from your runtime payload:
// console.log(JSON.stringify(response, null, 2));