Skip to main content

Registering Agents

Register an agent to begin governance. Navigate to Agents and click the Add Agent button in the top right corner.

Agent Creation Form

Workflow Engine

Select the workflow engine your agent uses:

EngineStatus
TemporalAvailable

Agent Information

FieldRequiredDescription
Agent NameYesHuman-readable name (e.g., "Customer Support Bot")
Agent IDAutoAuto-generated unique identifier (e.g., "CSB-001")
DescriptionNoWhat does this agent do?
TeamsNoAssign to teams for access control
IconNoVisual identifier (headphones, code, trending-up, file-search, bot)

API Key Generation

Every agent needs an API key to authenticate with OpenBox:

  1. Click Generate API Key
  2. Copy the key immediately
  3. Store it securely - you won't see it again

The key format is: obx_live_xxxxxxxxxxxx

Initial Risk Assessment

Expand the Initial Risk Assessment section and configure your agent's AIVSS risk parameters.

Risk Profile Presets

Select a preset that matches your agent's intended use:

LevelNameUse CasesDefault Governance
Level 1Minimal RiskRead-only access, internal research, no external APIsFully autonomous
Level 2Low RiskInternal automation, limited writes, monitored external callsMostly autonomous
Level 3Medium RiskCustomer data access, external API calls, financial readsApproval for sensitive ops
Level 4High RiskProduction admin, financial writes, PII accessHITL for most operations

AIVSS Parameters

AIVSS (AI Vulnerability Scoring System) evaluates risk across three categories:

Base Security (25% weight)

ParameterOptions
Attack VectorPhysical (1), Local (2), Adjacent (3), Network (4)
Attack ComplexityHigh (1), Medium (2), Low (3)
Privileges RequiredHigh (1), Low (2), None (3)
User InteractionRequired (1), None (2)
ScopeUnchanged (1), Changed (2)

AI-Specific (45% weight)

ParameterOptions
Prompt Injection RiskLow (1), Medium (2), High (3), Critical (4)
Data SensitivityPublic (1), Internal (2), Confidential (3), Restricted (4)
Autonomy LevelSupervised (1), Guided (2), Semi-autonomous (3), Autonomous (4)
Tool AccessNone (1), Read-only (2), Read-write (3), Admin (4)
External ConnectivityNone (1), Internal APIs (2), External APIs (3), Internet (4)

Impact (30% weight)

ParameterOptions
Confidentiality ImpactNone (1), Low (2), High (3)
Integrity ImpactNone (1), Low (2), High (3)
Availability ImpactNone (1), Low (2), High (3)
Business CriticalityLow (1), Medium (2), High (3), Critical (4)

Predicted Trust Tier

As you configure AIVSS parameters, the form shows a real-time prediction:

Predicted Trust Tier: TIER 2
Based on current configuration

See Assess for how AIVSS impacts Trust Score.

Attestation

In the Attestation section, configure cryptographic signing for audit-grade evidence.

For now, use AWS KMS (recommended/default):

  1. Select AWS KMS
  2. Keep the default settings

See Attestation for how execution evidence is produced and verified.

Goal Alignment (Goal Drift)

In the Goal Alignment section, configure drift detection:

  1. Set the alignment threshold (e.g., 70%)
  2. Choose what happens on drift detection:
    • Alert Only
    • Constrain
    • Terminate

See Verify for how goal alignment and drift detection work.

Creating the Agent

  1. Review all fields
  2. Ensure you've copied the API key
  3. Click Create Agent

You'll be redirected to the new agent's detail page.

Connecting Your Worker

Update your worker code to use the agent's API key:

worker = create_openbox_worker(
client=temporal_client,
task_queue="my-task-queue", # Should match your Temporal task queue
workflows=[MyAgentWorkflow],
activities=[my_activity],
openbox_api_key=os.environ.get("OPENBOX_API_KEY"), # The key you generated
)

The agent is matched by the API key. When your worker starts, it will appear as "Active" in the dashboard.

Next Steps

After creating your agent:

  1. Configure Trust Controls (Authorize) - Set up guardrails, policies, and behavioral rules before running your agent
  2. Connect Your Worker - Configure the SDK with your API key
  3. Monitor Sessions - Once running, watch your agent's activity in real-time