Buddy API

Name: Buddy API API
Brand: Buddy API
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsCi Cdbearer13 EndpointsREST

For Agents

Manage Buddy CI/CD pipelines and workspace environment variables, and read commits from connected repositories.

Quickstart

Get started with Buddy API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a Buddy pipeline"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Buddy API API.

Identify the authenticated Buddy user via /user for token validation

Create, list, update, and delete workspace-level environment variables for use across pipelines

Create and list CI/CD pipelines for a Buddy project under a workspace

Update or delete a pipeline by ID to reconfigure or retire it

GET STARTED

Start building with Buddy API API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Buddy API API for, with concrete tasks.

★ Pipeline Configuration as Code

Manage Buddy pipelines from a versioned configuration file rather than the Buddy UI by scripting createPipeline, updatePipeline, and deletePipeline against /workspaces/{workspace}/projects/{project_name}/pipelines. The same script can sync pipeline definitions across many projects, ensuring identical lint, test, and deploy stages everywhere. Useful for platform engineering teams standardising CI on Buddy.

Read the local pipeline.yaml, then for each pipeline call createPipeline or updatePipeline against /workspaces/{workspace}/projects/{project_name}/pipelines

Workspace Environment Variable Rotation

Rotate workspace-level environment variables (deploy keys, registry tokens, API secrets) on a schedule by calling listEnvironments to retrieve the current set, then updateEnvironment to replace each value with a freshly minted secret. The bearer-token auth model lets a rotation job run on a service account so secrets never appear in chat or pull requests.

Call listEnvironments for the workspace, then for each variable matching the rotation policy call updateEnvironment with the new value

Commit-Driven Release Notes

Build release notes by listing commits on the main branch via /workspaces/{workspace}/projects/{project_name}/repository/commits and grouping them by author or conventional-commit type. getCommit on a revision SHA returns the full commit message and metadata for richer note generation. This pattern keeps release notes faithful to what was actually deployed.

Call listCommits with the main branch and a date range, then for each SHA call getCommit and group the messages by conventional-commit prefix

AI Agent Pipeline Operations Through Jentic

Allow an AI agent to manage Buddy pipelines and environment variables on behalf of a developer without holding the Buddy access token. Through Jentic, the agent searches by intent, loads the relevant operation schema, and executes against /workspaces/{workspace}/* endpoints. The bearer token is stored in the Jentic vault and injected at execution time so credentials stay out of the agent's context.

Use Jentic to search 'create a Buddy pipeline', load the createPipeline schema, and execute against /workspaces/{workspace}/projects/{project_name}/pipelines

Key Endpoints

13 endpoints — this buddy ci/cd spec exposes the api.

METHOD

PATH

DESCRIPTION

GET

/user

Get the currently authenticated Buddy user

POST

/workspaces/{workspace}/environment

Create a workspace environment variable

GET

/workspaces/{workspace}/environment

List workspace environment variables

POST

/workspaces/{workspace}/projects/{project_name}/pipelines

Create a pipeline on a project

GET

/workspaces/{workspace}/projects/{project_name}/pipelines

List pipelines on a project

PATCH

/workspaces/{workspace}/projects/{project_name}/pipelines/{pipeline_id}

Update a pipeline

GET

/workspaces/{workspace}/projects/{project_name}/repository/commits

List repository commits

GET

/workspaces/{workspace}/projects/{project_name}/repository/commits/{revision}

Get a commit by revision SHA

GET

/user

Get the currently authenticated Buddy user

POST

/workspaces/{workspace}/environment

Create a workspace environment variable

GET

/workspaces/{workspace}/environment

List workspace environment variables

POST

/workspaces/{workspace}/projects/{project_name}/pipelines

Create a pipeline on a project

GET

/workspaces/{workspace}/projects/{project_name}/pipelines

List pipelines on a project

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Buddy personal access tokens are stored encrypted in the Jentic vault. Jentic injects the token as the Authorization: Bearer header at execution time so the raw token never appears in the agent's prompt, logs, or browser network tabs.

Intent-based discovery

Agents search by intent (e.g., 'create a Buddy pipeline') and Jentic returns the matching createPipeline operation with its schema, so the agent calls /workspaces/{workspace}/projects/{project_name}/pipelines without browsing Buddy's docs.

Time to first call

Direct Buddy integration: 1-2 days for OAuth handling, pipeline DSL construction, and environment variable management. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Buddy

Broader Buddy spec covering projects, actions, branches, and tags in addition to pipelines

Choose the buddy.works spec when an agent needs to create projects or manage individual pipeline actions

Complementary

Bubble Data API

Stores Buddy pipeline status records in a no-code Bubble app for stakeholder dashboards

Use when an internal Bubble dashboard should reflect Buddy pipeline state for non-engineering viewers

Complementary

Buffer API

Schedules release announcements after a successful Buddy pipeline run

Pair with this Buddy spec when an agent should post a release tweet when a pipeline completes

FAQs

Specific to using Buddy API API through Jentic.

What authentication does this Buddy API use?

Buddy uses OAuth 2.0 bearer tokens. Generate a personal access token in Buddy under My Profile → Access Tokens and send Authorization: Bearer <token> on every request. The /user endpoint is a quick way to validate the token returns the expected account. Through Jentic the access token is stored encrypted in the vault and injected at execution time.

Can I create a Buddy pipeline with this spec?

Yes. POST to /workspaces/{workspace}/projects/{project_name}/pipelines with a body specifying name, on (e.g., ON_EVERY_PUSH), refs (branches), and priority. Use updatePipeline at /workspaces/{workspace}/projects/{project_name}/pipelines/{pipeline_id} to reconfigure an existing pipeline. Note this spec does not include the action-management endpoints — see the buddy.works spec for those.

What are the rate limits for the Buddy API?

Buddy applies per-workspace rate limits that are not encoded in the spec. The API returns 429 responses when a client exceeds its share, and clients should back off before retrying. See buddy.works/docs/api for current per-plan limits.

How do I rotate a Buddy environment variable through Jentic?

Install the SDK with pip install jentic, search for 'update Buddy environment variable', load the updateEnvironment schema, and execute it against /workspaces/{workspace}/environment/{environment_id} with the new value. Jentic injects the bearer token from the vault and returns the updated record.

Can I read commits from this API?

Yes. GET /workspaces/{workspace}/projects/{project_name}/repository/commits returns the commit list, with query parameters for branch and limit. /repository/commits/{revision} returns a single commit by its SHA. These endpoints proxy to the underlying Git host that Buddy is connected to.

How is this different from the buddy.works spec?

Both target api.buddy.works. The buddyyen spec covers the user identity endpoint, pipelines, environment variables, and commit lookup (13 operations). The buddy.works spec is broader and includes project, action, branch, and tag management (24 operations). Pick whichever covers the operations your workflow needs.