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 Pipelines Pipeline Runs API
version: 1.0.0
extends: openapi/microsoft-azure-devops-pipeline-runs-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: 3
- target: $.paths['/pipelines/{pipelineId}/runs'].get
update:
x-apievangelist-phrasing:
intent: List a pipeline's runs
effect: read
questions:
- What recent runs has a YAML pipeline had, and did they pass?
- Can I page through the run history of a pipeline?
instructions:
- text: List the runs of pipeline {pipelineId}.
slots:
pipelineId: path.pipelineId
- text: Show the last {top} runs of pipeline {pipelineId}.
slots:
top: query.$top
pipelineId: path.pipelineId
method: generated
generated: '2026-09-26'
- target: $.paths['/pipelines/{pipelineId}/runs'].post
update:
x-apievangelist-phrasing:
intent: Start a pipeline run
effect: write
questions:
- How do I trigger a YAML pipeline with different template parameters?
- Can I skip some stages when starting a pipeline run?
instructions:
- text: Run pipeline {pipelineId}.
slots:
pipelineId: path.pipelineId
- text: Run pipeline {pipelineId} with template parameters {templateParameters}.
slots:
pipelineId: path.pipelineId
templateParameters: requestBody.templateParameters
- text: Start pipeline {pipelineId} skipping stages {stagesToSkip}.
slots:
pipelineId: path.pipelineId
stagesToSkip: requestBody.stagesToSkip
method: generated
generated: '2026-09-26'
- target: $.paths['/pipelines/{pipelineId}/runs/{runId}'].get
update:
x-apievangelist-phrasing:
intent: Get a pipeline run's details
effect: read
questions:
- What state and result did a specific pipeline run end with?
- Which variables and template parameters were used in one run?
instructions:
- text: Get run {runId} of pipeline {pipelineId}.
slots:
runId: path.runId
pipelineId: path.pipelineId
- text: Check whether run {runId} of pipeline {pipelineId} has finished.
slots:
runId: path.runId
pipelineId: path.pipelineId
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.