Generated by API Evangelist
Written by API Evangelist tooling for Airbyte's API. It is a proposal applied on top of the contract, not a document Airbyte publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for airbyte-api Public Regions API
version: 1.0.0
extends: openapi/airbyte-public-regions-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: 5
- target: $.paths['/regions'].get
update:
x-apievangelist-phrasing:
intent: List an organization's regions
effect: read
questions:
- What regions are set up for my organization?
- How do I find region ids to place dataplanes in?
instructions:
- text: List the regions for organization {organizationId}.
slots:
organizationId: query.organizationId
- text: Show all regions in organization {organizationId}.
slots:
organizationId: query.organizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/regions'].post
update:
x-apievangelist-phrasing:
intent: Create a region
effect: write
questions:
- How do I create a new region for my organization?
- Can I add a region that is disabled at first?
instructions:
- text: Create a region named {name} in organization {organizationId}.
slots:
name: requestBody.name
organizationId: requestBody.organizationId
- text: Add region {name} to organization {organizationId} with enabled set to {enabled}.
slots:
name: requestBody.name
organizationId: requestBody.organizationId
enabled: requestBody.enabled
method: generated
generated: '2026-09-26'
- target: $.paths['/regions/{regionId}'].get
update:
x-apievangelist-phrasing:
intent: Get a region
effect: read
questions:
- How do I look up one region's details?
- Is a specific region enabled?
instructions:
- text: Get region {regionId}.
slots:
regionId: path.regionId
- text: Show the details of region {regionId}.
slots:
regionId: path.regionId
method: generated
generated: '2026-09-26'
- target: $.paths['/regions/{regionId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a region
effect: destructive
questions:
- How do I delete a region?
- Can I remove a region my organization no longer uses?
instructions:
- text: Delete region {regionId}.
slots:
regionId: path.regionId
- text: Remove the region {regionId}.
slots:
regionId: path.regionId
method: generated
generated: '2026-09-26'
- target: $.paths['/regions/{regionId}'].patch
update:
x-apievangelist-phrasing:
intent: Rename or enable/disable a region
effect: write
questions:
- How do I disable a region without deleting it?
- Can I rename an existing region?
instructions:
- text: Set enabled to {enabled} on region {regionId}.
slots:
enabled: requestBody.enabled
regionId: path.regionId
- text: Rename region {regionId} to {name}.
slots:
regionId: path.regionId
name: requestBody.name
method: generated
generated: '2026-09-26'
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.