API Reference

BugOracle REST API documentation for programmatic access.

API Reference

BugOracle provides a REST API for programmatic error analysis and ingestion.

Authentication

All API requests require an Authorization header with your SDK Key:

curl -X POST https://bugoracle.com/api/v1/ingest \
  -H "x-bugoracle-client-key: bk_YOUR_SDK_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Error occurred", "stack": "..."}'

Get your SDK Key from Settings > Projects.

Endpoints

POST /api/v1/ingest

Ingest an error from your application for automatic analysis.

Request Body:

{
  "message": "TypeError: Cannot read property 'x' of undefined",
  "stack": "at Component (/app/src/page.tsx:42:12)\n...",
  "context": {
    "userId": "user_123",
    "page": "/dashboard"
  },
  "metadata": {
    "language": "typescript",
    "framework": "nextjs",
    "highlightSessionId": "sess_abc123"
  }
}

Response:

{
  "success": true,
  "id": "uuid-of-error-run",
  "diagnosis": "Pattern Match: Null Reference Error"
}

POST /api/analyze

Manually trigger a full AI analysis (requires user authentication).

Request Body:

{
  "error_log": "Full stack trace here...",
  "search_mode": "standard",
  "target_file": "src/components/Dashboard.tsx"
}

Response:

Streams analysis progress and returns the full runbook report.

Rate Limits

| Plan | Ingestion Rate | Analysis Rate | | ------- | -------------- | ------------- | | Free | 100/day | 30/day | | Starter | 1,000/day | 200/day | | Pro | 10,000/day | 600/day |

SDKs

For easier integration, use our official SDKs:

• @bugoracle/browser
• @bugoracle/node