Skip to main content
Something isn’t showing up in the dashboard. Before diving into code, run diagnostics to check config, registration, queue health, and event validation.

Doctor

npx apie doctor
npx apie doctor --send-test
npx apie doctor --mcp --mcp-config apie.mcp.json
doctor checks:
  • Config file loaded correctly
  • API key and base URL set
  • Agent registration succeeded (agentId, agentVersionId)
  • Queue is running and healthy
  • Sample events pass validation
--send-test sends a single test event after checks. --mcp validates MCP proxy config and connectivity.

What you’ll see

Structured output with pass/fail for each check. On success, agent and workspace IDs are printed.

Send test event

End-to-end smoke test with session replay URL:
npx apie send-test-event
npx apie send-test-event --mode pipeline
npx apie send-test-event --mode single
npx apie send-test-event --mode proof
ModeSimulates
pipeline (default)Full session: orchestrator, LLM, workflow, tool, guard, handoff, child run
singleMinimal session with one tool call
proofActivation proof: safe simulated session, risky production-like action, guardrail evaluation

What you’ll see

A session replay URL. Open it to verify the full pipeline appears in the dashboard.

SDK diagnostics

const report = await apie.doctor();
const queue = apie.queueDiagnostics();
const validation = await apie.validateEvents([sampleEvent]);
const test = await apie.sendTestEvent({ mode: "proof" });

Common issues

SymptomCheck
No events in dashboardAPIE_API_KEY set? ready() called? flush() before exit?
Registration failedAPIE_BASE_URL correct? API key valid?
Events rejectedRun validateEvents — check payload shapes
MCP proxy not interceptingdoctor --mcp — verify upstream command and config path
Queue growingNetwork issues? Increase retryAttempts or check onError setting

Disabled mode

If enabled: false, all checks pass locally but nothing is sent to Apie. Useful for CI without credentials.

Next steps

Connect your first agent

Initial setup walkthrough.

Errors reference

Error types and codes.