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 API
version: 1.0.0
extends: openapi/airbyte-public-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: 3
- target: $.paths['/embedded/widget_token'].post
update:
x-apievangelist-phrasing:
intent: Get a token for the Airbyte Embedded widget
effect: write
questions:
- How do I get a widget token so I can render the Airbyte Embedded widget in my app?
- Which allowed origin and external user id does the embedded widget token need?
- Can I request an embedded widget token when Embedded isn't enabled for my organization?
instructions:
- text: Get an embedded widget token for external user {externalUserId} in organization {organizationId}, allowing origin {allowedOrigin}.
slots:
externalUserId: requestBody.externalUserId
organizationId: requestBody.organizationId
allowedOrigin: requestBody.allowedOrigin
- text: Issue a widget token so {allowedOrigin} can load the embedded widget for end user {externalUserId} under organization {organizationId}.
slots:
allowedOrigin: requestBody.allowedOrigin
externalUserId: requestBody.externalUserId
organizationId: requestBody.organizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/embedded/scoped_token'].post
update:
x-apievangelist-phrasing:
intent: Generate a token scoped to an end-user workspace
effect: write
questions:
- How can I generate a token that only has access to one end user's workspace?
- Is there a way to hand an embedded customer a token limited to their own workspace?
instructions:
- text: Generate a scoped token for workspace {workspaceId}.
slots:
workspaceId: requestBody.workspaceId
- text: Create a workspace-scoped Embedded token for end-user workspace {workspaceId}.
slots:
workspaceId: requestBody.workspaceId
method: generated
generated: '2026-09-26'
- target: $.paths['/embedded/organizations'].get
update:
x-apievangelist-phrasing:
intent: List my organizations that have Embedded enabled
effect: read
questions:
- Which of my organizations have Airbyte Embedded turned on?
- What organizations can I use for embedded integrations with my current user?
instructions:
- text: List the organizations I can access that have Embedded enabled.
- text: Show which of my organizations are set up for Embedded.
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.