Generated by API Evangelist
Written by API Evangelist tooling for IntegrationOS's API. It is a proposal applied on top of the contract, not a document IntegrationOS publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for One Connection Definitions API
version: 1.0.0
extends: openapi/integration-os-connection-definitions-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: 2
- target: $.paths['/v1/connection-definitions'].get
update:
x-apievangelist-phrasing:
intent: Browse the connectors available to connect
effect: read
questions:
- Which platforms can I connect to, and what does each connector definition look like?
- Can I list only the connector definitions that support OAuth?
- How do I find the active connector definition for a specific platform?
instructions:
- text: List page {page} of connector definitions.
slots:
page: query.page
- text: Find the connector definitions for platform {platform}, page {page}.
slots:
platform: query.platform
page: query.page
- text: Show OAuth-capable connector definitions only ({hasOAuth}), page {page}.
slots:
hasOAuth: query.hasOAuth
page: query.page
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/connection-definitions/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one connector definition
effect: read
questions:
- What are the details of a single connector definition, by its ID?
- Can I see the authentication setup a particular connector definition requires?
instructions:
- text: Get connector definition {id}.
slots:
id: path.id
- text: Show connector definition {id} including its authentication details ({showAuthentication}).
slots:
id: path.id
showAuthentication: query.showAuthentication
method: generated
generated: '2026-10-01'
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.