ConfigurationRate Limiting

API Reference

System

Health checks and system information for monitoring API availability.

Health Check

Returns the current health status of the API and its dependent services. Returns HTTP 200 when healthy, or HTTP 503 with `status: "degraded"` when one or more core services are unavailable. Individual service statuses are reported as `"operational"` or `"disconnected"`. Use this endpoint for uptime monitoring and alerting.

GET/health
curl https://apply-api.boringproject.ai/health
Response200 OK
{
  "status": "healthy",
  "timestamp": "2024-02-14T16:00:00Z",
  "services": {
    "api": "operational",
    "database": "operational",
    "s3": "operational",
    "workers": "operational"
  }
}

API Version

Returns the current API version.

GET/version
curl https://apply-api.boringproject.ai/version
Response200 OK
{
  "version": "1.0.0"
}

Related docs

Continue reading

Introduction

The Boring Project API enables enterprise clients to automate job applications for their users across ATS platforms.

Rate Limiting

Understand API rate limits, response headers, and how to handle 429 responses gracefully with exponential backoff.

Error Handling

Every API error returns a consistent JSON structure with a machine-readable code, human-readable message, and optional details. Learn the full error taxonomy and how to handle each category.