# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shipments Address API
  version: 1.0.0
extends: openapi/sendcloud-address-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/addresses/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a shipping address
      effect: read
      questions:
      - Can I check that a shipping address is valid before I create a label?
      - Which carrier do I need to name when checking an address for deliverability?
      instructions:
      - text: Validate the address {address} for carrier {carrier_code}.
        slots:
          address: requestBody.address
          carrier_code: requestBody.carrier_code
      - text: Check whether {address} is a deliverable address before shipping with {carrier_code}.
        slots:
          address: requestBody.address
          carrier_code: requestBody.carrier_code
      method: generated
      generated: '2026-10-01'