Buildkite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Buildkite REST Agents API

4 actions 4 updates phrasing extends openapi/buildkite-com-agents-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Buildkite's API. It is a proposal applied on top of the contract, not a document Buildkite publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/organizations/{org}/agents'].get

$.paths['/organizations/{org}/agents/{id}'].get

$.paths['/organizations/{org}/agents/{id}/stop'].put

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Buildkite REST Agents API
  version: 1.0.0
extends: openapi/buildkite-com-agents-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/organizations/{org}/agents'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's agents
      effect: read
      questions:
      - Which build agents are connected to my organization right now?
      - How do I see all the Buildkite agents running for my org?
      instructions:
      - text: List all agents in organization {org}.
        slots:
          org: path.org
      - text: Show me every connected build agent for {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/agents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one agent
      effect: read
      questions:
      - What's the status and hostname of a specific build agent?
      - Can I look up a single agent by its UUID to see what job it's running?
      instructions:
      - text: Get agent {id} in organization {org}.
        slots:
          id: path.id
          org: path.org
      - text: Show me the details for agent {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organizations/{org}/agents/{id}/stop'].put
  update:
    x-apievangelist-phrasing:
      intent: Stop a running agent
      effect: destructive
      questions:
      - How do I stop a build agent remotely?
      - Can I shut down a misbehaving agent from the API instead of on the host?
      instructions:
      - text: Stop agent {id} in organization {org}.
        slots:
          id: path.id
          org: path.org
      - text: Shut down the build agent {id} remotely.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'