Appwrite · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Appwrite Avatars API
10 actions
10 updates
phrasing
extends
openapi/appwrite-avatars-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 10
$.info
$.paths['/avatars/browsers/{code}'].get
$.paths['/avatars/credit-cards/{code}'].get
$.paths['/avatars/favicon'].get
$.paths['/avatars/flags/{code}'].get
$.paths['/avatars/image'].get
$.paths['/avatars/initials'].get
$.paths['/avatars/photo'].get
$.paths['/avatars/qr'].get
$.paths['/avatars/screenshots'].get
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 Avatars API
version: 1.0.0
extends: openapi/appwrite-avatars-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: 9
- target: $.paths['/avatars/browsers/{code}'].get
update:
x-apievangelist-phrasing:
intent: Get a browser icon image
effect: read
questions:
- How can I show a Chrome or Firefox icon next to each of a user's sessions?
- Can I resize the browser logo image and set its quality?
instructions:
- text: Get the browser icon for code {code}.
slots:
code: path.code
- text: Render the {code} browser icon at {width}x{height} pixels.
slots:
code: path.code
width: query.width
height: query.height
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/credit-cards/{code}'].get
update:
x-apievangelist-phrasing:
intent: Get a credit card brand icon
effect: read
questions:
- Can I display the Visa or Mastercard logo for a saved card in my checkout UI?
- What sizes can the card network icon be returned in?
instructions:
- text: Get the credit card icon for {code}.
slots:
code: path.code
- text: Fetch the {code} card brand logo at {width} pixels wide with quality {quality}.
slots:
code: path.code
width: query.width
quality: query.quality
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/favicon'].get
update:
x-apievangelist-phrasing:
intent: Fetch a website's favicon
effect: read
questions:
- How do I grab the favicon of any website to show beside a link?
- Will the favicon lookup follow redirects on the site URL?
instructions:
- text: Fetch the favicon for {url}.
slots:
url: query.url
- text: Get the tab icon of the site at {url}.
slots:
url: query.url
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/flags/{code}'].get
update:
x-apievangelist-phrasing:
intent: Get a country flag icon
effect: read
questions:
- Can I show a country's flag from its two-letter code?
- What options exist to resize a flag image for a locale picker?
instructions:
- text: Get the flag for country code {code}.
slots:
code: path.code
- text: Render the {code} flag at {width}x{height}.
slots:
code: path.code
width: query.width
height: query.height
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/image'].get
update:
x-apievangelist-phrasing:
intent: Fetch and crop a remote image
effect: read
questions:
- How can I crop a remote image from a URL to a thumbnail size for my app?
- Is there a way to proxy an external image through Appwrite so it loads over HTTPS?
instructions:
- text: Fetch the image at {url} and crop it to {width}x{height}.
slots:
url: query.url
width: query.width
height: query.height
- text: Proxy the remote picture {url} through the avatars service.
slots:
url: query.url
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/initials'].get
update:
x-apievangelist-phrasing:
intent: Generate an initials avatar
effect: read
questions:
- How do I show a placeholder avatar with a user's initials?
- Can I pick the background color of the generated initials image?
instructions:
- text: Generate an initials avatar for {name}.
slots:
name: query.name
- text: Make an initials image for {name} with background {background}.
slots:
name: query.name
background: query.background
- text: Show the logged-in user's initials avatar.
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/photo'].get
update:
x-apievangelist-phrasing:
intent: Get the best available profile photo
effect: read
questions:
- Which sources are tried, in order, when looking up a user's profile photo?
- Can I get a Gravatar-style photo using just an email hash?
- How do I limit the profile photo lookup to a content rating?
instructions:
- text: Get the best profile photo for user {userId}.
slots:
userId: query.userId
- text: Look up a profile photo by email hash {emailHash} at {width} pixels.
slots:
emailHash: query.emailHash
width: query.width
- text: Return a photo for {name} in {output} format.
slots:
name: query.name
output: query.output
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/qr'].get
update:
x-apievangelist-phrasing:
intent: Generate a QR code image
effect: read
questions:
- How can I turn a piece of text or a link into a QR code image?
- Can I set the size and margin of the QR code and force it to download?
instructions:
- text: Make a QR code for {text}.
slots:
text: query.text
- text: Generate a {size}px QR code encoding {text} with margin {margin}.
slots:
size: query.size
text: query.text
margin: query.margin
method: generated
generated: '2026-09-26'
- target: $.paths['/avatars/screenshots'].get
update:
x-apievangelist-phrasing:
intent: Capture a screenshot of a webpage
effect: read
questions:
- How do I take a screenshot of a web page from its URL?
- Can the screenshot capture the full page in dark mode on a mobile-sized viewport?
- Is it possible to wait a few seconds before the page is captured?
instructions:
- text: Screenshot the page at {url}.
slots:
url: query.url
- text: Capture {url} with a {viewportWidth}x{viewportHeight} viewport in {theme} theme.
slots:
url: query.url
viewportWidth: query.viewportWidth
viewportHeight: query.viewportHeight
theme: query.theme
- text: Take a full-page capture of {url} set to {fullpage} after sleeping {sleep} seconds.
slots:
url: query.url
fullpage: query.fullpage
sleep: query.sleep
method: generated
generated: '2026-09-26'