# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Backend Organization Invitations API
  version: 1.0.0
extends: openapi/clerk-com-organization-invitations-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: 7
- target: $.paths['/organization_invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization invitations across the instance
      effect: read
      questions:
      - Which organization invitations exist across all organizations in my instance?
      - Can I search every organization invitation by email and filter by status?
      instructions:
      - text: List all organization invitations across my instance.
      - text: Search instance-wide organization invitations for {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations'].get
  update:
    x-apievangelist-phrasing:
      intent: List one organization's invitations
      effect: read
      questions:
      - Who has been invited to this organization, and have they accepted?
      - Can I filter an organization's invitations by status or email address?
      instructions:
      - text: List invitations for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Find invitations to {organization_id} sent to {email_address}.
        slots:
          organization_id: path.organization_id
          email_address: query.email_address
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite someone to an organization
      effect: write
      questions:
      - How do I invite a new member to an organization by email?
      - Can I set the role and expiry of an organization invitation?
      instructions:
      - text: Invite {email_address} to organization {organization_id} as {role}.
        slots:
          email_address: requestBody.email_address
          organization_id: path.organization_id
          role: requestBody.role
      - text: Send {email_address} an invitation to {organization_id} with role {role} expiring in {expires_in_days} days.
        slots:
          email_address: requestBody.email_address
          organization_id: path.organization_id
          role: requestBody.role
          expires_in_days: requestBody.expires_in_days
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite several people to an organization at once
      effect: write
      questions:
      - How do I send organization invitations to several emails in one request?
      - How many organization invitations can one bulk call send?
      instructions:
      - text: Bulk invite a batch of up to 10 emails to organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Send several organization invitations at once for {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations/pending'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's pending invitations
      effect: read
      questions:
      - Which invitations to this organization haven't been accepted yet?
      - Can I see only the still-usable invites for an organization?
      instructions:
      - text: List pending invitations for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show unaccepted invites to {organization_id}.
        slots:
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations/{invitation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an organization invitation
      effect: read
      questions:
      - What role and status does a specific organization invitation have?
      - Can I look up one organization invitation by its ID?
      instructions:
      - text: Get invitation {invitation_id} for organization {organization_id}.
        slots:
          invitation_id: path.invitation_id
          organization_id: path.organization_id
      - text: Show the status of org invite {invitation_id} in {organization_id}.
        slots:
          invitation_id: path.invitation_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organization_id}/invitations/{invitation_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a pending organization invitation
      effect: destructive
      questions:
      - How do I cancel an organization invitation that hasn't been accepted?
      - Can an already-accepted organization invitation still be revoked?
      instructions:
      - text: Revoke invitation {invitation_id} to organization {organization_id}.
        slots:
          invitation_id: path.invitation_id
          organization_id: path.organization_id
      - text: Cancel the pending invite {invitation_id} for {organization_id}.
        slots:
          invitation_id: path.invitation_id
          organization_id: path.organization_id
      method: generated
      generated: '2026-09-26'