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

Python SDKpython

decision = platform.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"},
    ],
})

print(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>

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

response = platform.risk.getConfig()
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

config = {}  # RiskRouterConfig

response = platform.risk.updateConfig(config)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

params = {}  # ListDecisionsParams

response = platform.risk.listDecisions(params)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # RiskSimulateInput

response = platform.risk.simulate(input)
print(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 }>

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

response = platform.risk.getConfigVersions()
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # RiskConfigDraftInput

response = platform.risk.saveDraft(input)
print(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 }>

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

response = platform.risk.clearDraft()
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # { changeSummary?: string }

response = platform.risk.publishDraft(input)
print(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

Python SDKpython

from arelis import create_arelis_platform
import os

platform = create_arelis_platform({
    "baseUrl": "https://api.arelis.digital",
    "apiKey": os.environ["ARELIS_API_KEY"],
})

input = {}  # RiskConfigRollbackInput

response = platform.risk.rollbackConfig(input)
print(response)

Response

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

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