API Reference

System

Health checks and system information endpoints for monitoring API availability and version.

Health Check

Check API availability and the status of all backend services. 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

Get the current API version, build date, and a link to the changelog.

GET/version

curl https://apply-api.boringproject.ai/version

Response200 OK

{
  "version": "1.0.0",
  "apiVersion": "v1",
  "buildDate": "2024-02-10",
  "changelog": "https://boringproject.ai/changelog"
}

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

Understand the API error format, HTTP status codes, error code categories, and best practices for handling errors.