Skip to main content

Registering Agents

Every AI agent you want to govern with OpenBox needs to be registered first. Registration creates the agent entity in the platform, generates an API key for SDK authentication, and sets the initial risk profile that determines how strictly OpenBox governs the agent's behavior.

Quick Steps

  1. Log in to the OpenBox Dashboard
  2. Navigate to Agents → Click Add Agent
  3. Configure the agent:
    • Workflow Engine: Temporal
    • Agent Name: Your agent name (e.g., "Customer Support Agent")
    • Description: What your agent does
    • Teams: Assign to one or more teams
    • Icon: Select an icon
  4. Generate API Key — Click Generate API Key, copy and store it (shown only once)
  5. Configure Initial Risk Assessment and Attestation (see details below)
  6. Click Add Agent
tip

Your API key format: obx_live_xxxxxxxxxxxx — store it securely, you won't see it again.

Detailed Configuration

Navigate to Agents and click the Add Agent button in the top right corner.

Workflow Engine

Select the workflow engine your agent uses:

EngineStatus
TemporalAvailable
n8nComing soon
LangChainComing soon

Agent Information

FieldRequiredDescription
Agent NameYesHuman-readable name (e.g., "Customer Support Agent")
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)
tip

All of these fields can be edited after creation from the Agent Settings page.

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 risk profile parameters

Risk Profile Presets

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

Risk TierRisk LevelRisk Profile ScoreUse CasesDefault Governance
Tier 1Low0% – 24%Read-only, public data accessFully autonomous
Tier 2Medium25% – 49%Internal data, non-critical actionsMostly autonomous
Tier 3High50% – 74%PII, financial data, critical actionsApproval for sensitive ops
Tier 4Critical75% – 100%System admin, destructive actionsHITL for most operations

Risk Profile Parameters

The Risk Profile evaluates risk across three categories:

Base Security (25% weight)
ParameterOptions
Attack VectorNetwork (1), Adjacent (2), Local (3), Physical (4)
Attack ComplexityLow (1), High (2)
Privileges RequiredNone (1), Low (2), High (3)
User InteractionNone (1), Required (2)
ScopeUnchanged (1), Changed (2)
AI-Specific (45% weight)
ParameterOptions
Model RobustnessVery High (1), High (2), Medium (3), Low (4), Very Low (5)
Data SensitivityVery High (1), High (2), Medium (3), Low (4), Very Low (5)
Ethical ImpactVery High (1), High (2), Medium (3), Low (4), Very Low (5)
Decision CriticalityVery High (1), High (2), Medium (3), Low (4), Very Low (5)
AdaptabilityVery High (1), High (2), Medium (3), Low (4), Very Low (5)
Impact (30% weight)
ParameterOptions
Confidentiality ImpactNone (1), Low (2), Medium (3), High (4), Critical (5)
Integrity ImpactNone (1), Low (2), Medium (3), High (4), Critical (5)
Availability ImpactNone (1), Low (2), Medium (3), High (4), Critical (5)
Safety ImpactNone (1), Low (2), Medium (3), High (4), Critical (5)

Predicted Risk Tier

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

Predicted Risk Tier: TIER 2
Based on current configuration

See Assess for how the Risk Profile 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.

Creating the Agent

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

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

Next Steps

Now that you have an agent and API key:

  • Wrap an Existing Agent — Already have a Temporal agent? Add the OpenBox trust layer
  • Run the Demo — Clone the demo repo and see governance in action
  • Agents — View and manage all registered agents