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

The kind of data this API exposes, based on its documentation. We could not call the endpoint to confirm the exact field names.

Buddy data via REST API

Example Response

Illustrative shape only — we were not able to call this endpoint (it requires credentials or exposes no public sample URL), so the fields below show the kind of data this API returns rather than a recorded response.

JSON Response · Illustrative
{
  "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

Calls a real endpoint of this API. Replace any placeholder credentials with your own key.

Request
const url = "https://api.buddy.works/workspaces";
// 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

Generated guidance based on this API's documentation, not observed by us. Treat it as a starting point and check against the provider's own error reference.

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.

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

Technical Specifications

Auth OAuth
HTTPS REQUIRED
CORS UNKNOWN
Difficulty Advanced
Listing details not endpoint-verified

Similar APIs

View All →