Netlify · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/netlify-agentrunnersession-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['/agent_runners/{agent_runner_id}/sessions'].get
$.paths['/agent_runners/{agent_runner_id}/sessions'].post
$.paths['/agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}'].get
$.paths['/agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}'].delete
$.paths['/agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}'].patch

OpenAPI Overlay

Raw ↑
# 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 Session API
  version: 1.0.0
extends: openapi/netlify-agentrunnersession-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['/agent_runners/{agent_runner_id}/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List sessions of an agent run
      effect: read
      questions:
      - What sessions have happened within an agent run?
      - Can I filter an agent run's sessions by state or date?
      instructions:
      - text: List sessions for agent run {runner}.
        slots:
          runner: path.agent_runner_id
      - text: Show sessions of agent run {runner} in state {state}.
        slots:
          runner: path.agent_runner_id
          state: query.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a follow-up session in an agent run
      effect: write
      questions:
      - How do I send a follow-up prompt to an existing agent run?
      - Can I switch the model for the next session of an agent run?
      instructions:
      - text: Start a new session on agent run {runner} with prompt {prompt}.
        slots:
          runner: path.agent_runner_id
          prompt: query.prompt
      - text: Continue agent run {runner} using model {model} and prompt {prompt}.
        slots:
          runner: path.agent_runner_id
          model: query.model
          prompt: query.prompt
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agent run session
      effect: read
      questions:
      - Can I see what happened in one session of an agent run?
      - What's the status of a specific agent session?
      instructions:
      - text: Get session {session} of agent run {runner}.
        slots:
          runner: path.agent_runner_id
          session: path.agent_runner_session_id
      - text: Show the result of session {session} in agent run {runner}.
        slots:
          runner: path.agent_runner_id
          session: path.agent_runner_session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an agent run session
      effect: destructive
      questions:
      - How do I delete a single session from an agent run?
      - Can I remove one session but keep the rest of the run?
      instructions:
      - text: Delete session {session} from agent run {runner}.
        slots:
          runner: path.agent_runner_id
          session: path.agent_runner_session_id
      - text: Remove agent session {session} in run {runner}.
        slots:
          runner: path.agent_runner_id
          session: path.agent_runner_session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent_runners/{agent_runner_id}/sessions/{agent_runner_session_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Publish or unpublish an agent run session
      effect: write
      questions:
      - Can I mark an agent session as published?
      - How do I change whether a session's result is published?
      instructions:
      - text: Mark session {session} of agent run {runner} as published.
        slots:
          runner: path.agent_runner_id
          session: path.agent_runner_session_id
      - text: Set published to {published} for session {session} of run {runner}.
        slots:
          published: query.is_published
          session: path.agent_runner_session_id
          runner: path.agent_runner_id
      method: generated
      generated: '2026-09-26'