# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clerk Com Redirect URLs API
  version: 1.0.0
extends: openapi/clerk-com-redirect-urls-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: 8
- target: $.paths['/redirect_urls'].get
  update:
    x-apievangelist-phrasing:
      intent: List allowed redirect URLs for the instance
      effect: read
      questions:
      - Which redirect URLs are whitelisted for my instance?
      - How do I page through my instance's allowed redirect URLs with my secret key?
      instructions:
      - text: List the allowed redirect URLs for this instance.
      - text: Show the first {limit} whitelisted redirect URLs.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/redirect_urls'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow a new redirect URL on the instance
      effect: write
      questions:
      - How do I add a redirect URL to my instance's whitelist, e.g. for a mobile app?
      - Can I whitelist a native app deep link as a redirect URL using the backend API?
      instructions:
      - text: Whitelist redirect URL {url} on this instance.
        slots:
          url: requestBody.url
      - text: Allow {url} as a redirect target for my instance.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/redirect_urls/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an instance redirect URL
      effect: read
      questions:
      - How do I look up a whitelisted redirect URL by its ID with the backend API?
      - What URL is stored under a given redirect URL ID on my instance?
      instructions:
      - text: Show instance redirect URL {id}.
        slots:
          id: path.id
      - text: Get the whitelisted URL stored as {id} on my instance.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/redirect_urls/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a redirect URL from the instance
      effect: destructive
      questions:
      - How do I remove a redirect URL from my instance's whitelist?
      - Can I stop allowing an old callback URL on this instance?
      instructions:
      - text: Remove redirect URL {id} from the instance whitelist.
        slots:
          id: path.id
      - text: Stop allowing instance redirect URL {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/redirect_urls'].get
  update:
    x-apievangelist-phrasing:
      intent: List redirect URLs for an application instance
      effect: read
      questions:
      - How do I list redirect URLs for one of my applications' production environment via the Platform API?
      - Can I pass an environment name instead of an instance ID when listing redirect URLs?
      instructions:
      - text: List redirect URLs for application {applicationID} in {envOrInsID}.
        slots:
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Show the first {limit} redirect URLs of app {applicationID} in {envOrInsID} via the Platform API.
        slots:
          limit: query.limit
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/redirect_urls'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a redirect URL to an application instance
      effect: write
      questions:
      - How do I add a redirect URL to a specific application's development instance via the Platform API?
      - Which Platform API scope is needed to create a redirect URL for an application?
      instructions:
      - text: Add redirect URL {url} to application {applicationID} environment {envOrInsID}.
        slots:
          url: requestBody.url
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Using the Platform API, allow {url} on app {applicationID} ({envOrInsID}).
        slots:
          url: requestBody.url
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/redirect_urls/{redirectURLID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a redirect URL on an application instance
      effect: read
      questions:
      - How do I read one redirect URL from an application's instance through the Platform API?
      - Which URL does a given redirect URL ID point to on an application's development instance?
      instructions:
      - text: Get redirect URL {redirectURLID} of application {applicationID} in {envOrInsID}.
        slots:
          redirectURLID: path.redirectURLID
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Using the Platform API, show redirect {redirectURLID} on app {applicationID} ({envOrInsID}).
        slots:
          redirectURLID: path.redirectURLID
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/applications/{applicationID}/instances/{envOrInsID}/redirect_urls/{redirectURLID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a redirect URL from an application instance
      effect: destructive
      questions:
      - How do I delete a redirect URL from one application's production instance with the Platform API?
      - Which Platform API scope lets me remove a redirect URL from an application?
      instructions:
      - text: Delete redirect URL {redirectURLID} from application {applicationID} in {envOrInsID}.
        slots:
          redirectURLID: path.redirectURLID
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      - text: Using the Platform API, remove redirect {redirectURLID} from app {applicationID} ({envOrInsID}).
        slots:
          redirectURLID: path.redirectURLID
          applicationID: path.applicationID
          envOrInsID: path.envOrInsID
      method: generated
      generated: '2026-09-26'