TextQL · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Textql.rpc.platform.Api Access Key Service API

6 actions 6 updates phrasing extends openapi/textql-textql-rpc-platform-apiaccesskeyservice-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['/v1/api-keys/create'].post
$.paths['/v1/api-keys/delete'].post
$.paths['/v1/api-keys'].post
$.paths['/v1/api-providers'].post
$.paths['/v1/api-keys/update'].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.rpc.platform.Api Access Key Service API
  version: 1.0.0
extends: openapi/textql-textql-rpc-platform-apiaccesskeyservice-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['/v1/api-keys/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a credential for an external API
      effect: write
      questions:
      - How do I give the agent a credential to call a third-party API?
      - Can I restrict a stored API credential to specific hosts?
      instructions:
      - text: Store an API access key for provider {provider} with auth value {auth_value}.
        slots:
          provider: requestBody.provider
          auth_value: requestBody.authValue
      - text: Create an access key limited to hosts {hosts} using auth type {auth_type}.
        slots:
          hosts: requestBody.hosts
          auth_type: requestBody.authType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/api-keys/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored API credential
      effect: destructive
      questions:
      - How do I remove an external API credential the agent was using?
      - Can I delete an API access key I stored?
      instructions:
      - text: Delete API access key {id}.
        slots:
          id: requestBody.id
      - text: Remove the stored external API credential {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/api-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: List stored API credentials
      effect: read
      questions:
      - Which external API credentials have been stored?
      - What third-party access keys can the agent use?
      instructions:
      - text: List my stored API access keys, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show every external API credential with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/api-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: List supported external API providers
      effect: read
      questions:
      - Which external API providers can I store credentials for?
      - What provider names are valid when creating an access key?
      instructions:
      - text: List supported API providers, sending Connect protocol version {protocol_version}.
        slots:
          protocol_version: header.Connect-Protocol-Version
      - text: Show the provider catalog for access keys with a {timeout_ms} ms timeout.
        slots:
          timeout_ms: header.Connect-Timeout-Ms
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/api-keys/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a stored API credential
      effect: write
      questions:
      - How do I change which hosts an existing API credential applies to?
      - Can I push back the expiry on a stored access key?
      instructions:
      - text: Update API access key {id} to allow hosts {hosts}.
        slots:
          id: requestBody.id
          hosts: requestBody.hosts
      - text: Set access key {id} to expire at {expires_at}.
        slots:
          id: requestBody.id
          expires_at: requestBody.expiresAt
      method: generated
      generated: '2026-10-01'