SDK Reference

Python and JavaScript/TypeScript clients for registering agents, verifying credentials, evaluating policy, and logging audit events.

Python

pip install neurionocta

JavaScript

npm install @neurionocta/sdk

NeurionOctaClient

Python

Main client class. Authenticates with your API key and sends requests to the NeurionOcta REST API.

Python

NeurionOctaClient(
    api_key: str,
    base_url: str = "https://neurionid-production.up.railway.app",
) -> NeurionOctaClient

Returns: NeurionOctaClient

NeurionOctaClient

JavaScript

Main client class. Authenticates with your API key and sends requests to the NeurionOcta REST API.

JavaScript

new NeurionOctaClient(
  apiKey: string,
  baseUrl?: string, // default: production Railway URL
)

Returns: NeurionOctaClient

register_agent

Python

register_agent(
    organization_id: str,
    agent_name: str,
    permissions: list[str],
    spending_limits: dict[str, float] | None = None,
) -> dict[str, Any]

Returns: dict — e.g. { "did": "did:neurion:...", "credential": {...}, ... }

registerAgent

JavaScript

registerAgent(
  organizationId: string,
  agentName: string,
  permissions: string[],
): Promise<Record<string, unknown>>

Returns: Promise<object> — e.g. { did, credential, ... }

verify_credential

Python

Fetch an agent's Verifiable Credential by DID and verify its cryptographic signature.

Python

verify_credential(did: str) -> dict[str, Any]

Returns: dict — e.g. { "valid": true, "credential": {...}, ... }

verifyCredential

JavaScript

Fetch an agent's Verifiable Credential by DID and verify its cryptographic signature.

JavaScript

verifyCredential(did: string): Promise<Record<string, unknown>>

Returns: Promise<object> — e.g. { valid, credential, ... }

check_policy

Python

Evaluate whether an agent is allowed to perform an action under your OPA/Rego policies.

Python

check_policy(
    agent_did: str,
    action: str,
    context: dict[str, Any] | None = None,
) -> dict[str, Any]

Returns: dict — e.g. { "allowed": true, "reason": "..." }

checkPolicy

JavaScript

Evaluate whether an agent is allowed to perform an action under your OPA/Rego policies.

JavaScript

checkPolicy(
  agentDid: string,
  action: string,
  context?: object,
): Promise<Record<string, unknown>>

Returns: Promise<object> — e.g. { allowed, reason, ... }

log_action

Python

Record an audit event for an agent action. Events are tamper-evident and can be blockchain-anchored.

Python

log_action(
    agent_did: str,
    action: str,
    details: dict[str, Any] | None = None,
) -> dict[str, Any]

Returns: dict — e.g. { "id": "...", "timestamp": "..." }

logAction

JavaScript

Record an audit event for an agent action. Events are tamper-evident and can be blockchain-anchored.

JavaScript

logAction(
  agentDid: string,
  action: string,
  details?: object,
): Promise<Record<string, unknown>>

Returns: Promise<object> — e.g. { id, timestamp, ... }