FeaturesAPI ReferenceOverview

BugBrain API Reference

The BugBrain API enables you to programmatically create tests, run them, retrieve results, and manage your account.

Base URL

https://api.bugbrain.tech

Authentication

All requests require a service API key (format: bugbrain_sk_*):

curl -H "Authorization: Bearer bugbrain_sk_abc123..." \
     https://api.bugbrain.tech/api/test-cases

Authentication guide →

Common Endpoints

MethodEndpointPurpose
GET/api/test-casesList all test cases
POST/api/test-casesCreate a test case
POST/api/executionsRun a test
GET/api/executions/[id]Get execution results
GET/api/executions/[id]/failure-analysisGet AI failure analysis

Full endpoint reference →

Rate Limits

  • Per-minute: 30 requests
  • Per-hour: 500 requests

Rate limit headers included in responses:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 497
X-RateLimit-Reset: 1614556800

Webhooks

Receive real-time notifications when tests complete:

{
  "event": "test.completed",
  "data": {
    "execution_id": "abc123",
    "status": "passed",
    "duration_ms": 8234
  }
}

Webhook reference →

API Sections

Code Examples

JavaScript

const fetch = require('node-fetch');
 
const response = await fetch('https://api.bugbrain.tech/api/test-cases', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer bugbrain_sk_abc123...',
    'Content-Type': 'application/json'
  }
});
 
const tests = await response.json();
console.log(tests);

Python

import requests
 
response = requests.get(
    'https://api.bugbrain.tech/api/test-cases',
    headers={
        'Authorization': 'Bearer bugbrain_sk_abc123...',
        'Content-Type': 'application/json'
    }
)
 
tests = response.json()
print(tests)

cURL

curl -H "Authorization: Bearer bugbrain_sk_abc123..." \
     https://api.bugbrain.tech/api/test-cases

Next Steps

Authentication — Learn about service keys Executions API — Run tests programmatically

JenkinsAuthentication