# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAI Chat API
  version: 1.0.0
extends: openapi/openai-chat-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/chat/completions'].get
  update:
    x-apievangelist-phrasing:
      intent: List stored chat completions
      effect: read
      questions:
      - Can I browse the chat completions I saved with store enabled?
      - Can I filter stored chat completions by model or metadata?
      instructions:
      - text: List my stored chat completions.
      - text: Show stored chat completions made with model {model}.
        slots:
          model: query.model
      - text: List stored completions tagged with metadata {metadata}.
        slots:
          metadata: query.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chat/completions'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a chat completion
      effect: write
      questions:
      - How do I send a list of chat messages to a model and get a reply?
      - Can I get structured JSON output or stream tokens from a chat completion?
      - Is there a way to ask for several alternative replies to the same messages?
      instructions:
      - text: Send {messages} to {model} and return its reply.
        slots:
          messages: requestBody.messages
          model: requestBody.model
      - text: Get {n} chat completion choices from {model} for {messages}.
        slots:
          n: requestBody.n
          model: requestBody.model
          messages: requestBody.messages
      - text: Chat with {model} using {messages} and reply in format {response_format}.
        slots:
          model: requestBody.model
          messages: requestBody.messages
          response_format: requestBody.response_format
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chat/completions/{completion_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a stored chat completion
      effect: read
      questions:
      - Can I look up a past chat completion by its ID?
      - Why can't I retrieve a chat completion that wasn't created with store set?
      instructions:
      - text: Get stored chat completion {completion_id}.
        slots:
          completion_id: path.completion_id
      - text: Show the saved output of chat completion {completion_id}.
        slots:
          completion_id: path.completion_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chat/completions/{completion_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update metadata on a stored chat completion
      effect: write
      questions:
      - Can I tag a stored chat completion with metadata after the fact?
      - What's the only thing I'm allowed to modify on a saved chat completion?
      instructions:
      - text: Set metadata {metadata} on chat completion {completion_id}.
        slots:
          metadata: requestBody.metadata
          completion_id: path.completion_id
      - text: Tag stored completion {completion_id} with {metadata}.
        slots:
          completion_id: path.completion_id
          metadata: requestBody.metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chat/completions/{completion_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored chat completion
      effect: destructive
      questions:
      - How do I delete a chat completion I stored?
      - Can I purge a saved chat completion so it's no longer kept?
      instructions:
      - text: Delete stored chat completion {completion_id}.
        slots:
          completion_id: path.completion_id
      - text: Purge the saved completion {completion_id}.
        slots:
          completion_id: path.completion_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chat/completions/{completion_id}/messages'].get
  update:
    x-apievangelist-phrasing:
      intent: List messages in a stored chat completion
      effect: read
      questions:
      - Which messages were sent in a chat completion I stored?
      - Can I page through the message history of one saved completion?
      instructions:
      - text: List the messages in stored chat completion {completion_id}.
        slots:
          completion_id: path.completion_id
      - text: Show the first {limit} messages from completion {completion_id}.
        slots:
          limit: query.limit
          completion_id: path.completion_id
      method: generated
      generated: '2026-09-26'