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 Runs API
version: 1.0.0
extends: openapi/microsoft-azure-devops-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['/{project}/_apis/pipelines/{pipelineId}/runs'].get
update:
x-apievangelist-phrasing:
intent: List runs of a pipeline
effect: read
questions:
- What runs has a pipeline had in a given project?
- Can I check the run history of a pipeline in Azure DevOps?
instructions:
- text: List runs of pipeline {pipelineId} in project {project} of organization {organization}.
slots:
pipelineId: path.pipelineId
project: path.project
organization: path.organization
- text: Show recent runs for pipeline {pipelineId} in {project}.
slots:
pipelineId: path.pipelineId
project: path.project
method: generated
generated: '2026-09-26'
- target: $.paths['/{project}/_apis/pipelines/{pipelineId}/runs'].post
update:
x-apievangelist-phrasing:
intent: Trigger a pipeline run
effect: write
questions:
- How do I start a pipeline run with custom variables?
- Can I skip stages when I trigger a pipeline?
instructions:
- text: Trigger a new run of pipeline {pipelineId} in project {project} of organization {organization}.
slots:
pipelineId: path.pipelineId
project: path.project
organization: path.organization
- text: Trigger pipeline {pipelineId} in {project} with variables {variables}.
slots:
pipelineId: path.pipelineId
project: path.project
variables: requestBody.variables
method: generated
generated: '2026-09-26'
- target: $.paths['/{project}/_apis/pipelines/{pipelineId}/runs/{runId}'].get
update:
x-apievangelist-phrasing:
intent: Get one pipeline run
effect: read
questions:
- Did a specific pipeline run succeed?
- What are the details of a single run I know the ID of?
instructions:
- text: Fetch details of run {runId} of pipeline {pipelineId} in project {project} of organization {organization}.
slots:
runId: path.runId
pipelineId: path.pipelineId
project: path.project
organization: path.organization
- text: Check the result of run {runId} of pipeline {pipelineId} in {project}.
slots:
runId: path.runId
pipelineId: path.pipelineId
project: path.project
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.