Generated by API Evangelist
Written by API Evangelist tooling for SendGrid's API. It is a proposal applied on top of the contract, not a document SendGrid publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Twilio SendGrid IP Address IP Addresses API
version: 1.0.0
extends: openapi/sendgrid-ip-addresses-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-24'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/v3/ips'].get
update:
x-apievangelist-phrasing:
intent: List all assigned and unassigned IPs
effect: read
questions:
- Which of my IPs are still warming up, and which subusers use them?
- Can I list IPs that belong to one subuser?
- Is there a way to leave out IPs used for branded links?
instructions:
- text: List all my IPs, assigned and unassigned.
- text: Show the IPs assigned to subuser {subuser}, {limit} per page.
slots:
subuser: query.subuser
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/ips'].post
update:
x-apievangelist-phrasing:
intent: Purchase additional IP addresses
effect: write
questions:
- How do I add more IP addresses to my account?
- Can new IPs start warmup automatically and go to specific subusers?
instructions:
- text: Add {count} IP addresses to my account.
slots:
count: requestBody.count
- text: Add {count} IPs with warmup {warmup} for subusers {subusers}.
slots:
count: requestBody.count
warmup: requestBody.warmup
subusers: requestBody.subusers
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/ips/{ip_address}'].get
update:
x-apievangelist-phrasing:
intent: See which pools an IP address belongs to
effect: read
questions:
- Which IP pools has a given IP address been added to?
- Can the same IP sit in more than one pool?
instructions:
- text: Show the pools that IP {ip_address} belongs to.
slots:
ip_address: path.ip_address
- text: Get pool membership for {ip_address}.
slots:
ip_address: path.ip_address
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/ips/assigned'].get
update:
x-apievangelist-phrasing:
intent: List only assigned IPs
effect: read
questions:
- Which of my IP addresses are currently assigned?
- Can I see just the assigned IPs and skip the unassigned ones?
instructions:
- text: List only my assigned IP addresses.
- text: Show the IPs that are assigned right now.
method: generated
generated: '2026-09-24'
- target: $.paths['/v3/ips/remaining'].get
update:
x-apievangelist-phrasing:
intent: Check how many more IPs I can add
effect: read
questions:
- How many more IP addresses can I still add this period, and at what price?
- What does an additional dedicated IP cost me?
instructions:
- text: Tell me how many IPs I can still add and their price.
- text: Get my remaining IP allowance for this period.
method: generated
generated: '2026-09-24'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.