IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One AI Runners API

19 actions 19 updates phrasing extends openapi/integration-os-ai-runners-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 19 · first 16 shown; the file carries all of them

$.info
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}'].get
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}'].post
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}'].delete
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/dashboard-password'].get
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/dashboard-password/regenerate'].post
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/proxy/{path}'].post
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}'].get
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}'].post
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}'].delete
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/dashboard-password'].get
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/dashboard-password/regenerate'].post
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/proxy/{path}'].post
$.paths['/v1/ai-runners/{agent_id}'].get
$.paths['/v1/ai-runners/{agent_id}'].post
$.paths['/v1/ai-runners/{agent_id}'].delete

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 One AI Runners API
  version: 1.0.0
extends: openapi/integration-os-ai-runners-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a project agent's runner status
      effect: read
      questions:
      - Is the runner behind my project-scoped AI agent up right now?
      - Where can I see whether a project agent's hosted runtime is running?
      instructions:
      - text: Check the runner status for agent {agent_id} in project {project_id} of organization {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Tell me if the project agent {agent_id}'s runner is alive in project {project_id}, org {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a project agent's runner if not running
      effect: write
      questions:
      - Can I make sure a project agent has a runner spun up before I send it work?
      - What brings a stopped runner for a project-scoped agent back online?
      instructions:
      - text: Ensure a runner is up for agent {agent_id} in project {project_id} of organization {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Spin up the project runner for agent {agent_id} under project {project_id}, org {org_id}, if it is not already running.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Tear down a project agent's runner
      effect: destructive
      questions:
      - How do I shut down and remove the runner for a project-scoped agent?
      - Does destroying a project agent's runner keep the agent itself?
      instructions:
      - text: Destroy the runner for agent {agent_id} in project {project_id} of organization {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Tear down project agent {agent_id}'s hosted runtime in project {project_id}, org {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/dashboard-password'].get
  update:
    x-apievangelist-phrasing:
      intent: Reveal a project runner's dashboard password
      effect: read
      questions:
      - Where do I find the dashboard password for a project agent's runner?
      - Can I look up the current runner dashboard login for an agent inside a project?
      instructions:
      - text: Show the runner dashboard password for agent {agent_id} in project {project_id}, org {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Reveal project {project_id}'s runner dashboard password for agent {agent_id} in organization {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/dashboard-password/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a project runner's dashboard password
      effect: write
      questions:
      - How can I rotate the runner dashboard password for a project-scoped agent?
      - If a project agent's dashboard password leaked, can I generate a new one?
      instructions:
      - text: Regenerate the runner dashboard password for agent {agent_id} in project {project_id}, org {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Issue a fresh dashboard password for project {project_id}'s agent runner {agent_id} in organization {org_id}.
        slots:
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/proxy/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Forward a request to a project agent's runner
      effect: write
      questions:
      - Can I send a request straight through to a project agent's runner?
      - How do I call an endpoint on the runtime hosting a project-scoped agent?
      instructions:
      - text: Proxy a request to path {path} on agent {agent_id}'s runner in project {project_id}, org {org_id}.
        slots:
          path: path.path
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Forward a call to {path} on the project runner for agent {agent_id} under project {project_id} in organization {org_id}.
        slots:
          path: path.path
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an organization agent's runner status
      effect: read
      questions:
      - Is the runner for an organization-scoped AI agent currently running?
      - What state is my org agent's hosted runtime in?
      instructions:
      - text: Check the runner status for organization agent {agent_id} in org {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Tell me whether org {org_id}'s agent {agent_id} has a live runner.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an organization agent's runner
      effect: write
      questions:
      - Can I make sure an organization-level agent's runner is spun up?
      - What restarts the hosted runtime for an org-scoped agent that went down?
      instructions:
      - text: Ensure a runner is running for organization agent {agent_id} in org {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Bring up the org-level runner for agent {agent_id} in organization {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Tear down an organization agent's runner
      effect: destructive
      questions:
      - How do I remove the runner hosting an organization-scoped agent?
      - Can I stop an org agent's runtime without deleting the agent?
      instructions:
      - text: Destroy the runner for organization agent {agent_id} in org {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Shut down org {org_id}'s runner for agent {agent_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/dashboard-password'].get
  update:
    x-apievangelist-phrasing:
      intent: Reveal an org runner's dashboard password
      effect: read
      questions:
      - Where is the dashboard password for an organization agent's runner?
      - Can I retrieve the login for an org-scoped agent's runner dashboard?
      instructions:
      - text: Show the runner dashboard password for organization agent {agent_id} in org {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Reveal org {org_id}'s runner dashboard login for agent {agent_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/dashboard-password/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an org runner's dashboard password
      effect: write
      questions:
      - How do I rotate the runner dashboard password for an organization agent?
      - Can I invalidate an org agent's old dashboard password and get a new one?
      instructions:
      - text: Regenerate the runner dashboard password for organization agent {agent_id} in org {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Rotate org {org_id}'s dashboard password for the runner of agent {agent_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/proxy/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Forward a request to an org agent's runner
      effect: write
      questions:
      - Can I pass a request through to the runner behind an organization agent?
      - How do I reach a specific path on an org-scoped agent's runtime?
      instructions:
      - text: Proxy a request to path {path} on organization agent {agent_id}'s runner in org {org_id}.
        slots:
          path: path.path
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Send a call to {path} through org {org_id}'s runner for agent {agent_id}.
        slots:
          path: path.path
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my agent's runner status
      effect: read
      questions:
      - Is the runner for my personal AI agent up?
      - How can I tell if my own agent's hosted runtime is running in One?
      instructions:
      - text: Check the runner status for my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Tell me if agent {agent_id} in my personal scope has a running runner.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Start my agent's runner if needed
      effect: write
      questions:
      - Can I make sure my personal agent has a runner before calling it?
      - What do I call to bring my own agent's runtime back up?
      instructions:
      - text: Ensure a runner is up for my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Start the personal runner for agent {agent_id} if it is stopped.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Tear down my agent's runner
      effect: destructive
      questions:
      - How do I destroy the runner hosting my personal agent?
      - Can I free up my own agent's runtime without removing the agent?
      instructions:
      - text: Destroy the runner for my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Tear down the personal-scope runtime for agent {agent_id}.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}/dashboard-password'].get
  update:
    x-apievangelist-phrasing:
      intent: Reveal my agent runner's dashboard password
      effect: read
      questions:
      - Where do I get the dashboard password for my personal agent's runner?
      - What is the login for my own agent's runner dashboard?
      instructions:
      - text: Show the runner dashboard password for my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Reveal the personal runner dashboard login for agent {agent_id}.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}/dashboard-password/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate my agent runner's dashboard password
      effect: write
      questions:
      - How can I rotate the dashboard password on my personal agent's runner?
      - Can I generate a replacement runner dashboard password for my own agent?
      instructions:
      - text: Regenerate the runner dashboard password for my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Rotate the personal dashboard password for agent {agent_id}'s runner.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}/proxy/{path}'].post
  update:
    x-apievangelist-phrasing:
      intent: Forward a request to my agent's runner
      effect: write
      questions:
      - Can I proxy a request through to my personal agent's runner?
      - How do I hit an endpoint on the runtime that hosts my own agent?
      instructions:
      - text: Proxy a request to path {path} on my agent {agent_id}'s runner.
        slots:
          path: path.path
          agent_id: path.agent_id
      - text: Forward a call to {path} on the personal runner for agent {agent_id}.
        slots:
          path: path.path
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'