TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TextQL Sandbox Exec Service API

6 actions 6 updates phrasing extends openapi/textql-sandboxexecservice-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for TextQL's API. It is a proposal applied on top of the contract, not a document TextQL publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/CreateSandbox'].post
$.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/Exec'].post
$.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/ExecuteCode'].post
$.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/GetToolAvailability'].post
$.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData'].post

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 TextQL Sandbox Exec Service API
  version: 1.0.0
extends: openapi/textql-sandboxexecservice-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: 5
- target: $.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/CreateSandbox'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an execution sandbox
      effect: write
      questions:
      - How do I create a sandbox for running code over the RPC service?
      - Can I choose the ID of a new sandbox myself?
      instructions:
      - text: Create sandbox {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      - text: Provision a new code execution sandbox with id {sandboxId}.
        slots:
          sandboxId: requestBody.sandboxId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/Exec'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a shell command in a sandbox
      effect: write
      questions:
      - Can I run a shell command in a sandbox over RPC?
      - How do I pass environment variables to a sandbox command?
      instructions:
      - text: Exec {command} in sandbox {sandboxId}.
        slots:
          command: requestBody.command
          sandboxId: requestBody.sandboxId
      - text: Run {command} of kind {kind} in sandbox {sandboxId} with env {env}.
        slots:
          command: requestBody.command
          kind: requestBody.kind
          sandboxId: requestBody.sandboxId
          env: requestBody.env
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/ExecuteCode'].post
  update:
    x-apievangelist-phrasing:
      intent: Execute code in a sandbox's kernel
      effect: write
      questions:
      - How do I run a block of Python in a sandbox through the exec service?
      - Does code sent to the sandbox kernel keep its variables for the next call?
      instructions:
      - text: Execute {code} in sandbox {sandboxId}.
        slots:
          code: requestBody.code
          sandboxId: requestBody.sandboxId
      - text: 'Send this code to the kernel of sandbox {sandboxId}: {code}'
        slots:
          sandboxId: requestBody.sandboxId
          code: requestBody.code
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/GetToolAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check which sandbox tools are available
      effect: read
      questions:
      - Which execution tools can I use in sandboxes right now?
      - Is code execution enabled for my organization?
      instructions:
      - text: Check sandbox tool availability.
      - text: List available sandbox tools within {timeout_ms} ms.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData'].post
  update:
    x-apievangelist-phrasing:
      intent: Load connector query results into a sandbox
      effect: write
      questions:
      - How do I query a connector and land the results in a sandbox dataframe over RPC?
      - Can I load data from a saved TQL path instead of writing SQL?
      instructions:
      - text: Load {query} from connector {connectorId} into sandbox {sandboxId}.
        slots:
          query: requestBody.query
          connectorId: requestBody.connectorId
          sandboxId: requestBody.sandboxId
      - text: Run TQL file {tqlPath} into dataframe {dataframeName}, capped at {maxRows} rows.
        slots:
          tqlPath: requestBody.tqlPath
          dataframeName: requestBody.dataframeName
          maxRows: requestBody.maxRows
      method: generated
      generated: '2026-10-01'