IntegrationOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for One AI Runner Secrets API

10 actions 10 updates phrasing extends openapi/integration-os-ai-runner-secrets-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-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/secrets'].get
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/secrets'].post
$.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/secrets/{secret_id}'].delete
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/secrets'].get
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/secrets'].post
$.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/secrets/{secret_id}'].delete
$.paths['/v1/ai-runners/{agent_id}/secrets'].get
$.paths['/v1/ai-runners/{agent_id}/secrets'].post
$.paths['/v1/ai-runners/{agent_id}/secrets/{secret_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 Runner Secrets API
  version: 1.0.0
extends: openapi/integration-os-ai-runner-secrets-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-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project agent's secrets
      effect: read
      questions:
      - Which secrets are stored for an AI agent that lives in a project?
      - Can I see the secret names configured on a project-scoped agent?
      instructions:
      - text: List the secrets 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 project {project_id} agent {agent_id} secrets in organization {org_id}.
        slots:
          project_id: path.project_id
          agent_id: path.agent_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}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a secret to a project agent
      effect: write
      questions:
      - How do I give an AI agent in a project an API key it can use at runtime?
      - Can I add a description when storing a secret for a project agent?
      instructions:
      - text: Store secret {name} with value {data} for agent {agent_id} in project {project_id}, org {org_id}.
        slots:
          name: requestBody.name
          data: requestBody.data
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Add project secret {name} to agent {agent_id} (project {project_id}, org {org_id}) using {data}.
        slots:
          name: requestBody.name
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/projects/{project_id}/{agent_id}/secrets/{secret_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret from a project agent
      effect: destructive
      questions:
      - How do I remove a stored secret from an AI agent in a project?
      - Can I delete one project agent secret without touching the others?
      instructions:
      - text: Delete secret {secret_id} from agent {agent_id} in project {project_id}, org {org_id}.
        slots:
          secret_id: path.secret_id
          agent_id: path.agent_id
          project_id: path.project_id
          org_id: path.org_id
      - text: Remove project {project_id} agent {agent_id}'s secret {secret_id} in organization {org_id}.
        slots:
          project_id: path.project_id
          agent_id: path.agent_id
          secret_id: path.secret_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization agent's secrets
      effect: read
      questions:
      - What secrets are configured on an AI agent owned by my organization?
      - Can I review the org-level agent secrets before rotating credentials?
      instructions:
      - text: List the secrets for organization {org_id} agent {agent_id}.
        slots:
          org_id: path.org_id
          agent_id: path.agent_id
      - text: Show org-scoped secrets on agent {agent_id} in {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}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a secret to an organization agent
      effect: write
      questions:
      - How do I store a credential on an AI agent that belongs to the whole organization?
      - Can an org-scoped agent hold its own named secrets?
      instructions:
      - text: Store secret {name} with value {data} on organization {org_id} agent {agent_id}.
        slots:
          name: requestBody.name
          data: requestBody.data
          org_id: path.org_id
          agent_id: path.agent_id
      - text: Add org-level secret {name} to agent {agent_id} in {org_id} using {data}.
        slots:
          name: requestBody.name
          agent_id: path.agent_id
          org_id: path.org_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/organizations/{org_id}/{agent_id}/secrets/{secret_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret from an organization agent
      effect: destructive
      questions:
      - How do I delete a secret from an AI agent owned by my organization?
      - Can I remove a leaked credential from an org-scoped agent?
      instructions:
      - text: Delete secret {secret_id} from organization {org_id} agent {agent_id}.
        slots:
          secret_id: path.secret_id
          org_id: path.org_id
          agent_id: path.agent_id
      - text: Remove org-level secret {secret_id} on agent {agent_id} in {org_id}.
        slots:
          secret_id: path.secret_id
          agent_id: path.agent_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List my personal agent's secrets
      effect: read
      questions:
      - Which secrets have I stored on one of my own AI agents?
      - Can I list a personal agent's secrets without an organization or project?
      instructions:
      - text: List the secrets on my agent {agent_id}.
        slots:
          agent_id: path.agent_id
      - text: Show the stored credentials for personal agent {agent_id}.
        slots:
          agent_id: path.agent_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a secret to my personal agent
      effect: write
      questions:
      - How do I give one of my own AI agents an API key to use when it runs?
      - Can I name and describe a secret I add to a personal agent?
      instructions:
      - text: Store secret {name} with value {data} on my agent {agent_id}.
        slots:
          name: requestBody.name
          data: requestBody.data
          agent_id: path.agent_id
      - text: Add secret {name} described as {description} to personal agent {agent_id}, value {data}.
        slots:
          name: requestBody.name
          description: requestBody.description
          agent_id: path.agent_id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/ai-runners/{agent_id}/secrets/{secret_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secret from my personal agent
      effect: destructive
      questions:
      - How do I remove a secret from one of my own AI agents?
      - Can I delete a single personal agent secret by its ID?
      instructions:
      - text: Delete secret {secret_id} from my agent {agent_id}.
        slots:
          secret_id: path.secret_id
          agent_id: path.agent_id
      - text: Remove personal agent {agent_id}'s stored credential {secret_id}.
        slots:
          agent_id: path.agent_id
          secret_id: path.secret_id
      method: generated
      generated: '2026-10-01'