Buddy API

Varies by plan (check documentation)

Overview

Buddy is a CI/CD automation platform focused on developer experience, featuring a visual pipeline builder and over 100 pre-built actions for Docker, Kubernetes, cloud deployments, and notifications. The REST API lets you programmatically create and manage projects, pipelines, and executions — useful for provisioning CI environments at scale. OAuth 2.0 is required, making it more complex to set up than API-key services.

💡

Beginner Tip

Buddy uses OAuth 2.0, so you must complete the authorization flow to get an access token before making any API call. For quick personal testing, create a personal access token in Buddy's UI under Profile → Access Tokens to skip the full OAuth dance.

Available Data

Buddy data via REST API
JSON-formatted response data
Requires OAuth authentication

Example Response

JSON Response
{
  "status": "success",
  "data": {
    "result": "Data from Buddy",
    "description": "The fastest continuous integration and continuous delivery platform",
    "timestamp": "2025-01-15T10:00:00Z"
  }
}

Field Reference

url API URL for this workspace — use it as the base for all workspace-scoped requests.
html_url Browser URL to open this workspace in the Buddy UI.
name Display name of the workspace.
domain Unique subdomain identifier used in API paths (e.g., "my-company" in api.buddy.works/my-company).
owner_id User ID of the workspace owner.

Implementation Example

const url = "https://buddy.works/docs/api/getting-started/overview";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "Authorization": "Bearer YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Common Errors & Troubleshooting

401 Unauthorized The access token has expired (tokens expire after 1 hour by default) or was not sent correctly.
Use the refresh token to get a new access token via `POST https://api.buddy.works/oauth2/token` with `grant_type=refresh_token`.
403 Forbidden on workspace endpoints The token does not have the required scope (e.g., `WORKSPACE` or `EXECUTION_INFO`).
Re-authorize the OAuth app and request the specific scopes your calls need, as listed in the Buddy API scope reference.
404 Not Found for a pipeline The workspace domain, project name, or pipeline ID in the URL path does not exist or is misspelled.
Call `GET /workspaces` to list your workspaces and their domains, then navigate down to projects and pipelines to find correct IDs.

Matrix Score Breakdown

🌐 Reachability 30/30
⚡ Speed 5/20
🔒 Security 15/15
🛠 Developer XP 3/20
✓ Reliability 10/15

Partially tested on Apr 5, 2026

Technical Specifications

Auth OAuth
HTTPS REQUIRED
CORS UNKNOWN
Difficulty Advanced
Verified: 2026-04-04

Similar APIs

View All →