Quickstart¶

Get a governed agent running in under 5 minutes.

1. Install¶

TypeScriptPython

npm install @agentgovernance/sdk

pip install agentgovernance

2. Get an API Key¶

curl -X POST https://agentgovernance.dev/api/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"name": "My Org", "slug": "my-org"}'

Response:

{
  "id": "uuid",
  "apiKey": "ag_abc123...",
  "slug": "my-org"
}

Warning

Save your API key. It is returned once and cannot be retrieved later.

3. Register an Agent¶

TypeScriptPythoncurl

import { AgentGovernance } from '@agentgovernance/sdk'

const client = new AgentGovernance({ apiKey: 'ag_...' })

const agent = await client.registerAgent({
  name: 'research-analyst',
  framework: 'crewai',  // or langgraph, autogen, custom
})

from agentgovernance import AgentGovernance

client = AgentGovernance(api_key="ag_...")

agent = client.register_agent(
    name="research-analyst",
    framework="crewai",
)

curl -X POST https://agentgovernance.dev/api/v1/agents/register \
  -H "Authorization: Bearer ag_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "research-analyst", "framework": "crewai"}'

4. Start a Governance Run¶

TypeScriptPython

const run = await client.startRun(agent.id)
// run.currentGate → 'plan'

run = client.start_run(agent.id)
# run.current_gate → 'plan'

5. Assess Agent Output¶

TypeScriptPython

const result = await client.assess({
  text: agentOutput,
  agentId: agent.id,
  runId: run.id,
})

if (result.summary.patternsDetected > 0) {
  console.log('Patterns found:', result.summary)
}

result = client.assess(
    text=agent_output,
    agent_id=agent.id,
    run_id=run.id,
)

if result.patterns_detected > 0:
    print(f"Patterns found: {result.patterns_detected}")

6. Approve Gates¶

TypeScriptPython

await client.approveGate({
  runId: run.id,
  actor: '[email protected]',
})

client.approve_gate(run_id=run.id, actor="[email protected]")