Appwrite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Appwrite Affiliates API
8 actions
8 updates
phrasing
extends
openapi/appwrite-affiliates-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Appwrite's API. It is a proposal applied on top of the contract, not a document Appwrite publishes.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/affiliates/links'].get
$.paths['/affiliates/links'].post
$.paths['/affiliates/links/{linkId}'].get
$.paths['/affiliates/links/{linkId}'].delete
$.paths['/affiliates/referrals'].get
$.paths['/affiliates/rewards'].get
$.paths['/affiliates/rewards/{rewardId}'].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 Appwrite Affiliates API
version: 1.0.0
extends: openapi/appwrite-affiliates-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: 7
- target: $.paths['/affiliates/links'].get
update:
x-apievangelist-phrasing:
intent: List my affiliate links
effect: read
questions:
- Which affiliate links have I created for my Appwrite account?
- Can I filter my shareable referral links with queries?
instructions:
- text: Show all of my affiliate links.
- text: List my affiliate links matching {queries}.
slots:
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/affiliates/links'].post
update:
x-apievangelist-phrasing:
intent: Create a shareable affiliate link
effect: write
questions:
- How do I get a referral link to share so I earn affiliate rewards?
- Do I need to join a program before creating an affiliate link, or am I already in it?
instructions:
- text: Create a new affiliate link with ID {linkId}.
slots:
linkId: requestBody.linkId
- text: Make an affiliate link {linkId} labelled {name} for my newsletter.
slots:
linkId: requestBody.linkId
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/affiliates/links/{linkId}'].get
update:
x-apievangelist-phrasing:
intent: Get one affiliate link
effect: read
questions:
- What are the details of a single affiliate link I own?
- Can I look up one referral link by its ID to copy the share URL?
instructions:
- text: Show the details of affiliate link {linkId}.
slots:
linkId: path.linkId
- text: Fetch my referral link {linkId}.
slots:
linkId: path.linkId
method: generated
generated: '2026-09-26'
- target: $.paths['/affiliates/links/{linkId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an affiliate link
effect: destructive
questions:
- If I delete an affiliate link, do the referrals and rewards it already earned stay in my history?
- How can I retire a referral link I no longer share?
instructions:
- text: Delete affiliate link {linkId}.
slots:
linkId: path.linkId
- text: Remove the referral link {linkId} from my account.
slots:
linkId: path.linkId
method: generated
generated: '2026-09-26'
- target: $.paths['/affiliates/referrals'].get
update:
x-apievangelist-phrasing:
intent: List referrals from my affiliate links
effect: read
questions:
- Who has signed up through my affiliate links so far?
- Does the referral list show referred users' emails, or only a truncated ID and signup country?
instructions:
- text: List the signups attributed to my affiliate links.
- text: Show my affiliate referrals matching {queries}.
slots:
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/affiliates/rewards'].get
update:
x-apievangelist-phrasing:
intent: List rewards earned from affiliate conversions
effect: read
questions:
- What rewards have I earned from affiliate conversions?
- Are any of my affiliate rewards still pending and waiting to be claimed?
instructions:
- text: List the rewards I have earned as an affiliate.
- text: Show my affiliate rewards filtered by {queries}.
slots:
queries: query.queries
method: generated
generated: '2026-09-26'
- target: $.paths['/affiliates/rewards/{rewardId}'].patch
update:
x-apievangelist-phrasing:
intent: Claim an affiliate reward as organization credits
effect: write
questions:
- How do I turn a pending affiliate reward into credits for one of my organizations?
- Must I be an owner of the organization that receives my claimed reward credits?
instructions:
- text: Claim reward {rewardId} by setting its status to {status} and credit organization {organizationId}.
slots:
rewardId: path.rewardId
status: requestBody.status
organizationId: requestBody.organizationId
- text: Mark affiliate reward {rewardId} as {status} for org {organizationId}.
slots:
rewardId: path.rewardId
status: requestBody.status
organizationId: requestBody.organizationId
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/appwrite-affiliates-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
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.
A second provider on the same verified email joins the account you already have.