IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One AI Agent Cron Runs API

10 actions 10 updates phrasing extends openapi/integration-os-ai-agent-cron-runs-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 10

$.info

$.paths['/v1/ai-agents/organizations/{org_id}/projects/{project_id}/{agent_id}/cron-runs'].get

$.paths['/v1/ai-agents/organizations/{org_id}/projects/{project_id}/{agent_id}/cron-runs'].post

$.paths['/v1/ai-agents/organizations/{org_id}/projects/{project_id}/{agent_id}/cron-runs/{id}'].get

$.paths['/v1/ai-agents/organizations/{org_id}/{agent_id}/cron-runs'].get

$.paths['/v1/ai-agents/organizations/{org_id}/{agent_id}/cron-runs'].post

$.paths['/v1/ai-agents/organizations/{org_id}/{agent_id}/cron-runs/{id}'].get

$.paths['/v1/ai-agents/{agent_id}/cron-runs'].get

$.paths['/v1/ai-agents/{agent_id}/cron-runs'].post

$.paths['/v1/ai-agents/{agent_id}/cron-runs/{id}'].get

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 One AI Agent Cron Runs API
  version: 1.0.0
extends: openapi/integration-os-ai-agent-cron-runs-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: 9
- target: $.paths['/v1/ai-agents/organizations/{org_id}/projects/{project_id}/{agent_id}/cron-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project agent's scheduled runs
      effect: read
      questions:
      - What has a project-scoped agent done on its schedule recently?
      - Can I page through a project agent's cron run history?
      instructions:
      - text: List cron runs 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: Show the recent scheduled invocations of project agent {agent_id} under project {project_id}, 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-agents/organizations/{org_id}/projects/{project_id}/{agent_id}/cron-runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a project agent's scheduled run
      effect: write
      questions:
      - How do I log a scheduled execution for an agent inside a project?
      - Can I record a failed project agent run along with its error?
      instructions:
      - text: Record a {status} cron run for agent {agent_id} in project {project_id}, org {org_id}, scheduled {scheduled_at}, started {started_at}.
        slots:
          status: requestBody.status
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
          scheduled_at: requestBody.scheduledAt
          started_at: requestBody.startedAt
      - text: Log project {project_id}'s agent {agent_id} run in org {org_id} with error {error}.
        slots:
          project_id: path.project_id
          agent_id: path.agent_id
          org_id: path.org_id
          error: requestBody.error
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/organizations/{org_id}/projects/{project_id}/{agent_id}/cron-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled run of a project agent
      effect: read
      questions:
      - How do I inspect a single scheduled run of a project agent?
      - Where is the record for one particular project agent cron execution?
      instructions:
      - text: Get cron run {id} for agent {agent_id} in project {project_id}, org {org_id}.
        slots:
          id: path.id
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Show project {project_id}'s run record {id} of agent {agent_id} in organization {org_id}.
        slots:
          project_id: path.project_id
          id: path.id
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/organizations/{org_id}/{agent_id}/cron-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List an org agent's scheduled runs
      effect: read
      questions:
      - What scheduled runs has an organization-level agent made lately?
      - Can I review the cron history of an org-scoped agent?
      instructions:
      - text: List cron runs for organization agent {agent_id} in org {org_id}.
        slots:
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Show page {page} of org {org_id}'s agent {agent_id} scheduled invocations.
        slots:
          page: query.page
          org_id: path.org_id
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/organizations/{org_id}/{agent_id}/cron-runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an org agent's scheduled run
      effect: write
      questions:
      - How do I log a scheduled execution of an organization agent?
      - Can an org agent's run record include its duration in milliseconds?
      instructions:
      - text: Record a {status} cron run for organization agent {agent_id} in org {org_id}, scheduled {scheduled_at}, started {started_at}.
        slots:
          status: requestBody.status
          agent_id: path.agent_id
          org_id: path.org_id
          scheduled_at: requestBody.scheduledAt
          started_at: requestBody.startedAt
      - text: Log org {org_id}'s agent {agent_id} run that took {duration_ms} ms.
        slots:
          org_id: path.org_id
          agent_id: path.agent_id
          duration_ms: requestBody.durationMs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/organizations/{org_id}/{agent_id}/cron-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled run of an org agent
      effect: read
      questions:
      - How can I look at one cron execution of an organization agent?
      - Where do I find a single org agent run's details?
      instructions:
      - text: Get cron run {id} for organization agent {agent_id} in org {org_id}.
        slots:
          id: path.id
          agent_id: path.agent_id
          org_id: path.org_id
      - text: Show org {org_id}'s run record {id} for agent {agent_id}.
        slots:
          org_id: path.org_id
          id: path.id
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/{agent_id}/cron-runs'].get
  update:
    x-apievangelist-phrasing:
      intent: List my agent's scheduled runs
      effect: read
      questions:
      - What has my personal agent been doing on its schedule?
      - Can I find my agent's failed scheduled runs to debug them?
      instructions:
      - text: List cron runs for my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Show the latest {limit} scheduled invocations of personal agent {agent_id}.
        slots:
          limit: query.limit
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/{agent_id}/cron-runs'].post
  update:
    x-apievangelist-phrasing:
      intent: Record my agent's scheduled run
      effect: write
      questions:
      - How is a scheduled run of my own agent recorded?
      - Can I save a response preview with a personal agent's cron run?
      instructions:
      - text: Record a {status} cron run for my agent {agent_id}, scheduled {scheduled_at}, started {started_at}.
        slots:
          status: requestBody.status
          agent_id: path.agent_id
          scheduled_at: requestBody.scheduledAt
          started_at: requestBody.startedAt
      - text: Log personal agent {agent_id}'s run with response preview {response_preview}.
        slots:
          agent_id: path.agent_id
          response_preview: requestBody.responsePreview
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-agents/{agent_id}/cron-runs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scheduled run of my agent
      effect: read
      questions:
      - What error did a specific scheduled run of my agent hit?
      - Can I view the response preview from one of my agent's cron runs?
      instructions:
      - text: Get cron run {id} for my agent {agent_id}.
        slots:
          id: path.id
          agent_id: path.agent_id
      - text: Show the personal run record {id} of agent {agent_id}.
        slots:
          id: path.id
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'