Bitly · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Bitly Campaigns API
9 actions
9 updates
phrasing
extends
openapi/bitly-campaigns-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Bitly's API. It is a proposal applied on top of the contract, not a document Bitly publishes.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/campaigns'].get
$.paths['/campaigns'].post
$.paths['/campaigns/{campaign_guid}'].get
$.paths['/campaigns/{campaign_guid}'].patch
$.paths['/channels'].get
$.paths['/channels'].post
$.paths['/channels/{channel_guid}'].get
$.paths['/channels/{channel_guid}'].patch
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Bitly Campaigns API
version: 1.0.0
extends: openapi/bitly-campaigns-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: 8
- target: $.paths['/campaigns'].get
update:
x-apievangelist-phrasing:
intent: List campaigns
effect: read
questions:
- What marketing campaigns have I set up in Bitly?
- Can I list only the campaigns that belong to one group?
instructions:
- text: List all my campaigns.
- text: Show the campaigns in group {group_guid}.
slots:
group_guid: query.group_guid
method: generated
generated: '2026-09-26'
- target: $.paths['/campaigns'].post
update:
x-apievangelist-phrasing:
intent: Create a campaign
effect: write
questions:
- How do I create a campaign to organize links across channels?
- Can I attach existing channels when I create a new campaign?
instructions:
- text: Create a campaign called {name} in group {group_guid}.
slots:
name: requestBody.name
group_guid: requestBody.group_guid
- text: Start a new campaign {name} described as {description} using channels {channel_guids}.
slots:
name: requestBody.name
description: requestBody.description
channel_guids: requestBody.channel_guids
method: generated
generated: '2026-09-26'
- target: $.paths['/campaigns/{campaign_guid}'].get
update:
x-apievangelist-phrasing:
intent: Get a campaign's details
effect: read
questions:
- Which channels are part of a specific campaign?
- How do I look up one campaign by its GUID?
instructions:
- text: Show campaign {campaign_guid}.
slots:
campaign_guid: path.campaign_guid
- text: Get the name, description and channels of campaign {campaign_guid}.
slots:
campaign_guid: path.campaign_guid
method: generated
generated: '2026-09-26'
- target: $.paths['/campaigns/{campaign_guid}'].patch
update:
x-apievangelist-phrasing:
intent: Update a campaign
effect: write
questions:
- Can I rename an existing campaign?
- How do I change which channels an existing campaign includes?
instructions:
- text: Rename campaign {campaign_guid} to {name}.
slots:
campaign_guid: path.campaign_guid
name: requestBody.name
- text: Set the channels on campaign {campaign_guid} to {channel_guids}.
slots:
campaign_guid: path.campaign_guid
channel_guids: requestBody.channel_guids
- text: Update campaign {campaign_guid}'s description to {description}.
slots:
campaign_guid: path.campaign_guid
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/channels'].get
update:
x-apievangelist-phrasing:
intent: List channels
effect: read
questions:
- What channels can I assign my links to?
- Which channels belong to a particular campaign?
instructions:
- text: List my channels.
- text: Show the channels in campaign {campaign_guid}.
slots:
campaign_guid: query.campaign_guid
- text: List channels available in group {group_guid}.
slots:
group_guid: query.group_guid
method: generated
generated: '2026-09-26'
- target: $.paths['/channels'].post
update:
x-apievangelist-phrasing:
intent: Create a channel
effect: write
questions:
- How do I add a new channel like email or social to group my links?
- Can I put specific Bitlinks into a channel when I create it?
instructions:
- text: Create a channel named {name} in group {group_guid}.
slots:
name: requestBody.name
group_guid: requestBody.group_guid
- text: Create a new channel {name} containing the links {bitlinks}.
slots:
name: requestBody.name
bitlinks: requestBody.bitlinks
method: generated
generated: '2026-09-26'
- target: $.paths['/channels/{channel_guid}'].get
update:
x-apievangelist-phrasing:
intent: Get a channel's details
effect: read
questions:
- Which Bitlinks are in a specific channel?
- What group does a given channel belong to?
instructions:
- text: Show channel {channel_guid}.
slots:
channel_guid: path.channel_guid
- text: List the links inside channel {channel_guid}.
slots:
channel_guid: path.channel_guid
method: generated
generated: '2026-09-26'
- target: $.paths['/channels/{channel_guid}'].patch
update:
x-apievangelist-phrasing:
intent: Update a channel
effect: write
questions:
- Can I rename a channel I already created?
- How do I change which links an existing channel contains?
instructions:
- text: Rename channel {channel_guid} to {name}.
slots:
channel_guid: path.channel_guid
name: requestBody.name
- text: Replace the links in channel {channel_guid} with {bitlinks}.
slots:
channel_guid: path.channel_guid
bitlinks: requestBody.bitlinks
method: generated
generated: '2026-09-26'