Back to OpenBuild

API Reference

Authenticate and interact with the OpenBuild API

Authentication

All API requests require an API key passed via the X-OpenBuild-Key header.

Getting an API Key

  1. 1.Go to Settings → API Keys
  2. 2.Click "Create API Key"
  3. 3.Copy and store the key securely

Important: API keys are only shown once. Store them securely!

Key Format

API keys follow this format:

ob_<prefix>_<secret>
  • ob_ - OpenBuild identifier
  • <prefix> - 8 character identifier (visible in settings)
  • <secret> - Secret portion (never shown again)

Example Request

# Using curl
curl -H "X-OpenBuild-Key: ob_abc12345_xxxxxxxxxxxx" \
https://openbuild.so/api/projects

Rate Limits

API requests are rate limited per API key:

Limit TypeValue
Requests per minute100
Requests per hour1,000
Requests per day10,000

Rate limit headers are included in every response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1704067200

Error Responses

API errors return JSON with an error field:

401Unauthorized
{ "error": "Invalid or expired API key" }
429Rate Limited
{ "error": "Rate limit exceeded", "retry_after": 60 }
404Not Found
{ "error": "Project not found" }

Base URL

All API requests should be made to:

https://openbuild.so/api

Using the MCP Server?

The MCP server handles authentication automatically. Just set your API key as an environment variable.

MCP Setup Guide