Who the API is for

The Orchpad API is for developers who want to integrate Orchpad into their own tools, trigger builds programmatically, or automate project creation as part of a larger workflow.

If you're a non-technical user building products through the Orchpad interface, you don't need the API.

Base URL

https://api.orchpad.com/v1

All endpoints are relative to this base URL. All requests and responses use JSON.

Versioning

The API is versioned via the URL path (/v1). Breaking changes will be introduced in a new version (/v2). The current version will remain supported for a minimum of 12 months after a new version is released.

Rate limits

Rate limit headers are included in every response:

• X-RateLimit-Limit — your limit
• X-RateLimit-Remaining — requests remaining in the current window
• X-RateLimit-Reset — Unix timestamp when the window resets

Response format

All responses follow this shape:

{
  "data": { ... },
  "error": null
}

On error:

{
  "data": null,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}