Netlify Agent Runner API
The agentRunner API from Netlify — 6 operation(s) for agentrunner.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/netlify-agentrunner-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
version: 2.57.0
title: Netlify's API documentation Agent Runner API
description: Netlify is a hosting service for the programmable web.
termsOfService: https://www.netlify.com/legal/terms-of-use/
x-logo:
url: netlify-logo.png
href: https://www.netlify.com/docs/
altText: Netlify
servers:
- url: https://api.netlify.com/api/v1
security:
- netlifyAuth: []
tags:
- name: agentRunner
paths:
/agent_runners:
get:
operationId: listAgentRunners
tags:
- agentRunner
parameters:
- name: account_id
in: query
required: true
schema:
type: string
- name: site_id
in: query
required: true
schema:
type: string
- name: page
required: false
in: query
schema:
type: integer
format: int32
- name: per_page
required: false
in: query
schema:
type: integer
format: int32
- name: state
in: query
schema:
type: string
enum:
- live
- error
- name: title
in: query
schema:
type: string
- name: branch
in: query
schema:
type: string
- name: result_branch
in: query
schema:
type: string
- name: from
in: query
schema:
type: integer
- name: to
in: query
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
site_id:
type: string
parent_agent_runner_id:
type: string
state:
type: string
created_at:
type: string
format: dateTime
updated_at:
type: string
format: dateTime
done_at:
type: string
format: dateTime
title:
type: string
branch:
type: string
result_branch:
type: string
pr_url:
type: string
pr_branch:
type: string
pr_state:
type: string
pr_number:
type: integer
pr_is_being_created:
type: boolean
pr_error:
type: string
current_task:
type: string
result_diff:
type: string
sha:
type: string
merge_commit_sha:
type: string
merge_commit_error:
type: string
merge_commit_is_being_created:
type: boolean
base_deploy_id:
type: string
attached_file_keys:
type: array
items:
type: string
active_session_created_at:
type: string
format: dateTime
latest_session_deploy_id:
type: string
latest_session_deploy_url:
type: string
user:
type: object
properties:
id:
type: string
full_name:
type: string
email:
type: string
avatar_url:
type: string
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: List agent runners
x-summary-source: derived
post:
operationId: createAgentRunner
tags:
- agentRunner
parameters:
- name: site_id
in: query
required: true
schema:
type: string
- name: deploy_id
in: query
schema:
type: string
- name: branch
in: query
schema:
type: string
- name: prompt
in: query
schema:
type: string
- name: agent
in: query
schema:
type: string
- name: model
in: query
schema:
type: string
- name: parent_agent_runner_id
in: query
schema:
type: string
- name: dev_server_image
in: query
schema:
type: string
- name: file_keys
in: query
schema:
type: array
items:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
site_id:
type: string
parent_agent_runner_id:
type: string
state:
type: string
created_at:
type: string
format: dateTime
updated_at:
type: string
format: dateTime
done_at:
type: string
format: dateTime
title:
type: string
branch:
type: string
result_branch:
type: string
pr_url:
type: string
pr_branch:
type: string
pr_state:
type: string
pr_number:
type: integer
pr_is_being_created:
type: boolean
pr_error:
type: string
current_task:
type: string
result_diff:
type: string
sha:
type: string
merge_commit_sha:
type: string
merge_commit_error:
type: string
merge_commit_is_being_created:
type: boolean
base_deploy_id:
type: string
attached_file_keys:
type: array
items:
type: string
active_session_created_at:
type: string
format: dateTime
latest_session_deploy_id:
type: string
latest_session_deploy_url:
type: string
user:
type: object
properties:
id:
type: string
full_name:
type: string
email:
type: string
avatar_url:
type: string
'404':
description: Not Found
'422':
description: Unprocessable Entity
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Create agent runner
x-summary-source: derived
/agent_runners/upload_url:
post:
x-internal: true
operationId: createAgentRunnerUploadUrl
tags:
- agentRunner
parameters:
- name: account_id
in: query
required: true
schema:
type: string
- name: filename
in: query
required: true
schema:
type: string
- name: content_type
in: query
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
'422':
description: Unprocessable Entity
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Create agent runner upload url
x-summary-source: derived
/agent_runners/{agent_runner_id}:
parameters:
- name: agent_runner_id
in: path
required: true
schema:
type: string
get:
operationId: getAgentRunner
tags:
- agentRunner
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
site_id:
type: string
parent_agent_runner_id:
type: string
state:
type: string
created_at:
type: string
format: dateTime
updated_at:
type: string
format: dateTime
done_at:
type: string
format: dateTime
title:
type: string
branch:
type: string
result_branch:
type: string
pr_url:
type: string
pr_branch:
type: string
pr_state:
type: string
pr_number:
type: integer
pr_is_being_created:
type: boolean
pr_error:
type: string
current_task:
type: string
result_diff:
type: string
sha:
type: string
merge_commit_sha:
type: string
merge_commit_error:
type: string
merge_commit_is_being_created:
type: boolean
base_deploy_id:
type: string
attached_file_keys:
type: array
items:
type: string
active_session_created_at:
type: string
format: dateTime
latest_session_deploy_id:
type: string
latest_session_deploy_url:
type: string
user:
type: object
properties:
id:
type: string
full_name:
type: string
email:
type: string
avatar_url:
type: string
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Get agent runner
x-summary-source: derived
patch:
operationId: updateAgentRunner
tags:
- agentRunner
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
site_id:
type: string
parent_agent_runner_id:
type: string
state:
type: string
created_at:
type: string
format: dateTime
updated_at:
type: string
format: dateTime
done_at:
type: string
format: dateTime
title:
type: string
branch:
type: string
result_branch:
type: string
pr_url:
type: string
pr_branch:
type: string
pr_state:
type: string
pr_number:
type: integer
pr_is_being_created:
type: boolean
pr_error:
type: string
current_task:
type: string
result_diff:
type: string
sha:
type: string
merge_commit_sha:
type: string
merge_commit_error:
type: string
merge_commit_is_being_created:
type: boolean
base_deploy_id:
type: string
attached_file_keys:
type: array
items:
type: string
active_session_created_at:
type: string
format: dateTime
latest_session_deploy_id:
type: string
latest_session_deploy_url:
type: string
user:
type: object
properties:
id:
type: string
full_name:
type: string
email:
type: string
avatar_url:
type: string
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Update agent runner
x-summary-source: derived
delete:
operationId: deleteAgentRunner
tags:
- agentRunner
responses:
'202':
description: Accepted
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Delete agent runner
x-summary-source: derived
/agent_runners/{agent_runner_id}/archive:
parameters:
- name: agent_runner_id
in: path
required: true
schema:
type: string
post:
operationId: archiveAgentRunner
tags:
- agentRunner
responses:
'202':
description: Accepted
'404':
description: Not Found
'422':
description: Unprocessable Entity
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Archive agent runner
x-summary-source: derived
/agent_runners/{agent_runner_id}/pull_request:
parameters:
- name: agent_runner_id
in: path
required: true
schema:
type: string
post:
x-internal: true
operationId: agentRunnerPullRequest
tags:
- agentRunner
responses:
'200':
description: OK
'400':
description: Bad Request
'409':
description: Conflict
'422':
description: Unprocessable Entity
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Agent runner pull request
x-summary-source: derived
/agent_runners/{agent_runner_id}/commit:
parameters:
- name: agent_runner_id
in: path
required: true
schema:
type: string
post:
x-internal: true
operationId: agentRunnerCommitToBranch
tags:
- agentRunner
parameters:
- name: target_branch
in: query
required: true
schema:
type: string
responses:
'200':
description: OK
'400':
description: Bad Request
'409':
description: Conflict
'422':
description: Unprocessable Entity
default:
description: error
content:
application/json:
schema:
type: object
required:
- message
properties:
code:
type: integer
format: int64
message:
type: string
summary: Agent runner commit to branch
x-summary-source: derived
components:
securitySchemes:
netlifyAuth:
type: oauth2
flows:
implicit:
scopes: {}
authorizationUrl: https://app.netlify.com/authorize
externalDocs:
url: https://www.netlify.com/docs/api/
description: Online documentation
x-tagGroups:
- name: OAuth
tags:
- ticket
- accessToken
- name: User accounts
tags:
- user
- accountMembership
- member
- accountType
- paymentMethod
- auditLog
- name: Site
tags:
- site
- environmentVariables
- file
- metadata
- purge
- snippet
- name: Domain names
tags:
- dnsZone
- sniCertificate
- name: Deploys
tags:
- deploy
- deployedBranch
- deployKey
- name: Builds
tags:
- build
- buildLogMsg
- name: Dev servers
tags:
- devServer
- name: Webhooks and notifications
tags:
- hook
- hookType
- buildHook
- devServerHook
- name: Services
tags:
- service
- serviceInstance
- name: Functions
tags:
- function
- name: Database
tags:
- database
- name: Forms
tags:
- form
- submission
- name: Split tests
tags:
- splitTest
- name: Large media
tags:
- asset
- assetPublicSignature