Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Agent Runner Hook API

6 actions 6 updates phrasing extends openapi/netlify-agentrunnerhook-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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/sites/{site_id}/agent_runner_hooks'].get

$.paths['/sites/{site_id}/agent_runner_hooks'].post

$.paths['/sites/{site_id}/agent_runner_hooks/{id}'].get

$.paths['/sites/{site_id}/agent_runner_hooks/{id}'].put

$.paths['/sites/{site_id}/agent_runner_hooks/{id}'].delete

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 Hook API
  version: 1.0.0
extends: openapi/netlify-agentrunnerhook-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: 5
- target: $.paths['/sites/{site_id}/agent_runner_hooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's agent run hooks
      effect: read
      questions:
      - Which agent run hooks are set up for my site?
      - Can I see the URLs that trigger AI agent runs on a site?
      instructions:
      - text: List agent run hooks for site {site}.
        slots:
          site: path.site_id
      - text: Show every agent runner hook on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/agent_runner_hooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent run hook
      effect: write
      questions:
      - How do I create a hook URL that kicks off an AI agent run?
      - Can I preset the prompt and agent that a hook triggers?
      instructions:
      - text: Create an agent run hook on site {site} titled {title} with prompt {prompt}.
        slots:
          site: path.site_id
          title: requestBody.title
          prompt: requestBody.prompt
      - text: Add an agent run hook on site {site} for branch {branch} using agent {agent}.
        slots:
          site: path.site_id
          branch: requestBody.branch
          agent: requestBody.agent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/agent_runner_hooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent run hook
      effect: read
      questions:
      - What prompt does a particular agent run hook use?
      - Can I look up one agent runner hook's settings?
      instructions:
      - text: Get agent run hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      - text: Show the prompt and agent for hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/agent_runner_hooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an agent run hook
      effect: write
      questions:
      - Can I change the prompt an agent run hook sends?
      - How do I point an agent run hook at a different branch?
      instructions:
      - text: Change the prompt of agent run hook {hook} on site {site} to {prompt}.
        slots:
          hook: path.id
          site: path.site_id
          prompt: requestBody.prompt
      - text: Point agent run hook {hook} on site {site} at branch {branch}.
        slots:
          hook: path.id
          site: path.site_id
          branch: requestBody.branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/agent_runner_hooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent run hook
      effect: destructive
      questions:
      - How do I remove an agent run hook?
      - Can I revoke a hook URL that starts agent runs?
      instructions:
      - text: Delete agent run hook {hook} from site {site}.
        slots:
          site: path.site_id
          hook: path.id
      - text: Remove agent runner hook {hook} on site {site}.
        slots:
          site: path.site_id
          hook: path.id
      method: generated
      generated: '2026-09-26'