# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for TextQL Sandbox Capability Service API
  version: 1.0.0
extends: openapi/textql-sandboxcapabilityservice-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: 6
- target: $.paths['/textql.rpc.public.sandbox_capability.SandboxCapabilityService/ExecuteWrite'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a write statement through a declared capability
      effect: write
      questions:
      - Can sandbox code write to a database through a connector?
      - How do I run an insert or update statement from a sandbox capability?
      instructions:
      - text: Execute write capability {name} on connector {connectorId} with statement {statement}.
        slots:
          name: requestBody.name
          connectorId: requestBody.connectorId
          statement: requestBody.statement
      - text: Run write {name} with parameters {parameters}.
        slots:
          name: requestBody.name
          parameters: requestBody.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_capability.SandboxCapabilityService/PollAsk'].post
  update:
    x-apievangelist-phrasing:
      intent: Poll for an agent ask's progress
      effect: read
      questions:
      - How do I check whether an agent ask started from a sandbox has finished?
      - Can I resume polling an ask from a cursor?
      instructions:
      - text: Poll ask {askId} on agent {agentId}.
        slots:
          askId: requestBody.askId
          agentId: requestBody.agentId
      - text: Get new output for ask {askId} after cursor {cursor}.
        slots:
          askId: requestBody.askId
          cursor: requestBody.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_capability.SandboxCapabilityService/PutAsset'].post
  update:
    x-apievangelist-phrasing:
      intent: Store an asset file from a sandbox
      effect: write
      questions:
      - How does sandbox code save an image or file as an asset?
      - Do I need to give a content type when storing an asset?
      instructions:
      - text: Store asset {fileName} of type {contentType}.
        slots:
          fileName: requestBody.fileName
          contentType: requestBody.contentType
      - text: Upload asset data {data} as {fileName}.
        slots:
          data: requestBody.data
          fileName: requestBody.fileName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_capability.SandboxCapabilityService/SendNotify'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a notification through a capability
      effect: write
      questions:
      - Can sandbox code send a notification with a subject and body?
      - How do I fire a declared notify capability from an app?
      instructions:
      - text: Send notification {name} with subject {subject}.
        slots:
          name: requestBody.name
          subject: requestBody.subject
      - text: Notify via {name} with body {body}.
        slots:
          name: requestBody.name
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_capability.SandboxCapabilityService/StartAsk'].post
  update:
    x-apievangelist-phrasing:
      intent: Ask an agent a question from a sandbox
      effect: write
      questions:
      - Can my app hand a prompt to a TextQL agent and get an answer later?
      - How do I continue a previous agent ask with a follow-up?
      instructions:
      - text: Start an ask to agent {agentId} with prompt {prompt}.
        slots:
          agentId: requestBody.agentId
          prompt: requestBody.prompt
      - text: Follow up on ask {continueAskId} with {prompt}.
        slots:
          continueAskId: requestBody.continueAskId
          prompt: requestBody.prompt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_capability.SandboxCapabilityService/StateOp'].post
  update:
    x-apievangelist-phrasing:
      intent: Read or write a key in capability state
      effect: write
      questions:
      - Can sandbox code keep key-value state between runs?
      - How do I get or set a value in a particular state scope?
      instructions:
      - text: Perform state op {op} on key {key} in scope {scope}.
        slots:
          op: requestBody.op
          key: requestBody.key
          scope: requestBody.scope
      - text: Set state key {key} to {value}.
        slots:
          key: requestBody.key
          value: requestBody.value
      method: generated
      generated: '2026-10-01'