Generated by API Evangelist
Written by API Evangelist tooling for Azure DevOps's API. It is a proposal applied on top of the contract, not a document Azure DevOps publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Azure DevOps Builds API
version: 1.0.0
extends: openapi/microsoft-azure-devops-builds-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/build/builds'].get
update:
x-apievangelist-phrasing:
intent: List builds
effect: read
questions:
- Which builds failed on the main branch recently?
- Can I filter builds by status, result or who requested them?
- What were the latest builds for a given build definition?
instructions:
- text: List the last {top} builds for definition {definitions}.
slots:
top: query.$top
definitions: query.definitions
- text: List builds on branch {branchName} with result {resultFilter}.
slots:
branchName: query.branchName
resultFilter: query.resultFilter
- text: Show builds requested by {requestedFor} that are {statusFilter}.
slots:
requestedFor: query.requestedFor
statusFilter: query.statusFilter
method: generated
generated: '2026-09-26'
- target: $.paths['/build/builds'].post
update:
x-apievangelist-phrasing:
intent: Queue a new build
effect: write
questions:
- How do I kick off a build of a specific definition on a chosen branch?
- Can I pass build parameters or a priority when queuing a build?
instructions:
- text: Queue a build of definition {definition}.
slots:
definition: requestBody.definition
- text: Queue a build of definition {definition} on branch {sourceBranch}.
slots:
definition: requestBody.definition
sourceBranch: requestBody.sourceBranch
- text: Queue definition {definition} with parameters {parameters}.
slots:
definition: requestBody.definition
parameters: requestBody.parameters
method: generated
generated: '2026-09-26'
- target: $.paths['/build/builds/{buildId}'].get
update:
x-apievangelist-phrasing:
intent: Get a build's status and result
effect: read
questions:
- Did a particular build succeed, and how long did it take?
- What source branch and commit did a given build run against?
instructions:
- text: Get the status and result of build {buildId}.
slots:
buildId: path.buildId
- text: Show me details of build {buildId}.
slots:
buildId: path.buildId
method: generated
generated: '2026-09-26'
- target: $.paths['/build/builds/{buildId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a build
effect: destructive
questions:
- Can I delete a build record together with its logs and artifacts?
- Is deleting a build reversible?
instructions:
- text: Delete build {buildId}.
slots:
buildId: path.buildId
- text: Permanently remove build {buildId} and its logs and artifacts.
slots:
buildId: path.buildId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.