# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAI Chatkit API
  version: 1.0.0
extends: openapi/openai-chatkit-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['/chatkit/sessions/{session_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an active ChatKit session
      effect: destructive
      questions:
      - How do I shut down a ChatKit session so its client secret stops working?
      - Can I cancel a ChatKit session and still see its latest metadata?
      instructions:
      - text: Cancel ChatKit session {session_id}.
        slots:
          session_id: path.session_id
      - text: Revoke the client secret for ChatKit session {session_id} by cancelling it.
        slots:
          session_id: path.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chatkit/sessions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a ChatKit session for a user
      effect: write
      questions:
      - How do I create a ChatKit session to embed chat for one of my users?
      - Can I set rate limits and an expiry on a new ChatKit session?
      instructions:
      - text: Create a ChatKit session for user {user} running workflow {workflow}.
        slots:
          user: requestBody.user
          workflow: requestBody.workflow
      - text: Start a ChatKit session for {user} on {workflow} that expires after {expires_after}.
        slots:
          user: requestBody.user
          workflow: requestBody.workflow
          expires_after: requestBody.expires_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chatkit/threads/{thread_id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in a ChatKit thread
      effect: read
      questions:
      - What messages and items are in a particular ChatKit thread?
      - Can I read a ChatKit thread's items oldest first?
      instructions:
      - text: List the items in ChatKit thread {thread_id}.
        slots:
          thread_id: path.thread_id
      - text: Show ChatKit thread {thread_id}'s items ordered {order}.
        slots:
          thread_id: path.thread_id
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chatkit/threads/{thread_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a ChatKit thread
      effect: read
      questions:
      - Can I fetch a ChatKit thread by its identifier?
      - What's the title and status of one ChatKit conversation?
      instructions:
      - text: Show ChatKit thread {thread_id}.
        slots:
          thread_id: path.thread_id
      - text: Get the details of ChatKit conversation {thread_id}.
        slots:
          thread_id: path.thread_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chatkit/threads/{thread_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ChatKit thread and its attachments
      effect: destructive
      questions:
      - How do I delete a ChatKit conversation along with its stored attachments?
      - Does deleting a ChatKit thread also remove its items?
      instructions:
      - text: Delete ChatKit thread {thread_id}.
        slots:
          thread_id: path.thread_id
      - text: Remove ChatKit conversation {thread_id} with all its items and attachments.
        slots:
          thread_id: path.thread_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/chatkit/threads'].get
  update:
    x-apievangelist-phrasing:
      intent: List ChatKit threads
      effect: read
      questions:
      - Which ChatKit threads exist for my app?
      - Can I list only the ChatKit threads belonging to one end user?
      instructions:
      - text: List all ChatKit threads.
      - text: Show the ChatKit threads for user {user}.
        slots:
          user: query.user
      method: generated
      generated: '2026-09-26'