# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OpenAI Invites API
  version: 1.0.0
extends: openapi/openai-invites-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: 4
- target: $.paths['/organization/invites'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization invites
      effect: read
      questions:
      - Who has been invited to my organization?
      - Can I see all outstanding invites to the org, page by page?
      instructions:
      - text: List the invites in my organization.
      - text: Show the first {limit} organization invites.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/invites'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a user to the organization
      effect: write
      questions:
      - How do I invite a teammate to my OpenAI organization?
      - Can I add someone to specific projects at the same time I invite them?
      - Which roles can I give a person when inviting them?
      instructions:
      - text: Invite {email} to the organization as {role}.
        slots:
          email: requestBody.email
          role: requestBody.role
      - text: Invite {email} as an org {role} with access to projects {projects}.
        slots:
          email: requestBody.email
          role: requestBody.role
          projects: requestBody.projects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/invites/{invite_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an invite
      effect: read
      questions:
      - Has a particular invite been accepted yet?
      - Can I look up one organization invite by its ID?
      instructions:
      - text: Get invite {invite_id}.
        slots:
          invite_id: path.invite_id
      - text: Check the status of invite {invite_id}.
        slots:
          invite_id: path.invite_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organization/invites/{invite_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an organization invite
      effect: destructive
      questions:
      - Can I cancel an invite I sent to the wrong email?
      - Why can't I delete an invite that's already been accepted?
      instructions:
      - text: Delete invite {invite_id}.
        slots:
          invite_id: path.invite_id
      - text: Revoke the pending invite {invite_id}.
        slots:
          invite_id: path.invite_id
      method: generated
      generated: '2026-09-26'