Netlify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Netlify's API documentation Agent Runner API
10 actions
10 updates
phrasing
extends
openapi/netlify-agentrunner-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/agent_runners'].get
$.paths['/agent_runners'].post
$.paths['/agent_runners/upload_url'].post
$.paths['/agent_runners/{agent_runner_id}'].get
$.paths['/agent_runners/{agent_runner_id}'].delete
$.paths['/agent_runners/{agent_runner_id}'].patch
$.paths['/agent_runners/{agent_runner_id}/archive'].post
$.paths['/agent_runners/{agent_runner_id}/pull_request'].post
$.paths['/agent_runners/{agent_runner_id}/commit'].post
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 Netlify's API documentation Agent Runner API
version: 1.0.0
extends: openapi/netlify-agentrunner-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: 9
- target: $.paths['/agent_runners'].get
update:
x-apievangelist-phrasing:
intent: List agent runs for a site
effect: read
questions:
- Which AI agent runs have been started on my site?
- Can I filter agent runs by state or branch?
- How do I find agent runs from a certain date range?
instructions:
- text: List agent runs for site {site} in account {account}.
slots:
site: query.site_id
account: query.account_id
- text: Show agent runs on site {site} in account {account} that are in state {state}.
slots:
site: query.site_id
account: query.account_id
state: query.state
- text: List agent runs for site {site}, account {account}, on branch {branch}.
slots:
site: query.site_id
account: query.account_id
branch: query.branch
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners'].post
update:
x-apievangelist-phrasing:
intent: Start an AI agent run on a site
effect: write
questions:
- How do I kick off an AI agent to make changes to my Netlify site?
- Can I choose which agent and model runs the task?
instructions:
- text: Start an agent run on site {site} with the prompt {prompt}.
slots:
site: query.site_id
prompt: query.prompt
- text: Run agent {agent} using model {model} on branch {branch} of site {site} with prompt {prompt}.
slots:
agent: query.agent
model: query.model
branch: query.branch
site: query.site_id
prompt: query.prompt
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/upload_url'].post
update:
x-apievangelist-phrasing:
intent: Get an upload URL for an agent run file
effect: write
questions:
- Can I attach a file for an agent run to use?
- Where do I upload images or files before starting an agent run?
instructions:
- text: Get an upload URL in account {account} for file {filename} of type {content_type}.
slots:
account: query.account_id
filename: query.filename
content_type: query.content_type
- text: Create a signed upload link for {filename} ({content_type}) for agent runs in account {account}.
slots:
filename: query.filename
content_type: query.content_type
account: query.account_id
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}'].get
update:
x-apievangelist-phrasing:
intent: Get an agent run
effect: read
questions:
- What is the status of my agent run?
- Can I see the details of a single agent run?
instructions:
- text: Get agent run {runner}.
slots:
runner: path.agent_runner_id
- text: Check the progress of agent run {runner}.
slots:
runner: path.agent_runner_id
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an agent run
effect: destructive
questions:
- How do I delete an agent run I don't need?
- Can I permanently remove an agent run?
instructions:
- text: Delete agent run {runner}.
slots:
runner: path.agent_runner_id
- text: Permanently remove agent run {runner}.
slots:
runner: path.agent_runner_id
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}'].patch
update:
x-apievangelist-phrasing:
intent: Update an agent run
effect: write
questions:
- Can I change an agent run after it's been created?
- Is it possible to edit an existing agent run?
instructions:
- text: Update agent run {runner}.
slots:
runner: path.agent_runner_id
- text: Modify the settings of agent run {runner}.
slots:
runner: path.agent_runner_id
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/archive'].post
update:
x-apievangelist-phrasing:
intent: Archive an agent run
effect: write
questions:
- How do I archive an agent run without deleting it?
- Can I hide finished agent runs by archiving them?
instructions:
- text: Archive agent run {runner}.
slots:
runner: path.agent_runner_id
- text: Move agent run {runner} to the archive.
slots:
runner: path.agent_runner_id
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/pull_request'].post
update:
x-apievangelist-phrasing:
intent: Open a pull request from an agent run
effect: write
questions:
- Can an agent run open a pull request with its changes?
- How do I turn an agent's changes into a PR for review?
instructions:
- text: Open a pull request from agent run {runner}.
slots:
runner: path.agent_runner_id
- text: Create a PR with the changes made by agent run {runner}.
slots:
runner: path.agent_runner_id
method: generated
generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/commit'].post
update:
x-apievangelist-phrasing:
intent: Commit agent run changes to a branch
effect: write
questions:
- Can I commit an agent run's changes straight to a branch?
- Which branch receives the commit from an agent run?
instructions:
- text: Commit the changes from agent run {runner} to branch {branch}.
slots:
runner: path.agent_runner_id
branch: query.target_branch
- text: Push agent run {runner}'s work directly onto {branch}.
slots:
runner: path.agent_runner_id
branch: query.target_branch
method: generated
generated: '2026-09-26'