Generated by API Evangelist
Written by API Evangelist tooling for Envia.com's API. It is a proposal applied on top of the contract, not a document Envia.com publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Envia Queries Carriers API
version: 1.0.0
extends: openapi/envia-carriers-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-20'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/available-carrier-detailed/{country}/{international}/{shipment_type_id}'].get
update:
x-apievangelist-phrasing:
intent: List carriers available for a shipment type
effect: read
questions:
- Which carriers can I ship a parcel to Canada with?
- Can I get the freight carriers available for a country?
instructions:
- text: List carriers for {country} with international {international} for shipment type {shipment_type_id}.
slots:
country: path.country
international: path.international
shipment_type_id: path.shipment_type_id
- text: Show available {shipment_type_id} carriers in {country}, international {international}.
slots:
shipment_type_id: path.shipment_type_id
country: path.country
international: path.international
method: generated
generated: '2026-11-20'
- target: $.paths['/carrier'].get
update:
x-apievangelist-phrasing:
intent: List active carriers for a country
effect: read
questions:
- Which carriers are available for creating shipments in Mexico?
- Can I get the active carriers for a country before quoting a shipment?
instructions:
- text: List active carriers for {country_code}.
slots:
country_code: query.country_code
- text: Show the carriers available for {country_code}.
slots:
country_code: query.country_code
method: generated
generated: '2026-11-20'
- target: $.paths['/carrier-action/{carrier_id}'].get
update:
x-apievangelist-phrasing:
intent: List actions a carrier supports
effect: read
questions:
- What actions does a carrier support, like tracking or label printing?
- Can I see the actions available for one carrier?
instructions:
- text: Get the actions for carrier {carrier_id}.
slots:
carrier_id: path.carrier_id
- text: Show what carrier {carrier_id} supports.
slots:
carrier_id: path.carrier_id
method: generated
generated: '2026-11-20'
- target: $.paths['/carrier/{carrier_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a single carrier's details
effect: read
questions:
- What are the details of one specific carrier?
- Can I look up a carrier by its ID?
instructions:
- text: Get carrier {carrier_id}.
slots:
carrier_id: path.carrier_id
- text: Show the details of carrier {carrier_id}.
slots:
carrier_id: path.carrier_id
method: generated
generated: '2026-11-20'
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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.