Appwrite Avatars API

openapi: 3.0.0
info:
  title: Appwrite Avatars API
  description: Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
  version: 2.0.0
  termsOfService: https://appwrite.io/policy/terms
  contact:
    name: Appwrite Team
    url: https://appwrite.io/support
    email: team@appwrite.io
  license:
    name: BSD-3-Clause
    url: https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE
servers:
- url: https://cloud.appwrite.io/v1
  description: Appwrite Cloud endpoint.
- url: https://{region}.cloud.appwrite.io/v1
  description: Appwrite Cloud regional endpoint. Replace `{region}` with your project region.
  variables:
    region:
      default: fra
      description: Appwrite Cloud region.
tags:
- name: avatars
  description: The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.
paths:
  /avatars/browsers/{code}:
    get:
      summary: Get browser icon
      operationId: avatarsGetBrowser
      tags:
      - avatars
      description: 'You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.


        When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.'
      responses:
        '200':
          description: Image
          content:
            image/png:
              schema:
                type: string
                format: binary
      deprecated: false
      x-appwrite:
        group: null
        demo: avatars/get-browser.md
        rate-limit: 0
        rate-time: 3600
        rate-key: url:{url},ip:{ip}
        scope: avatars.read
        platforms:
        - console
        - client
        - server
        packaging: false
        public: true
        auth:
          console:
            Project: []
            ImpersonateUserId: []
          client:
            Project: []
            ImpersonateUserId: []
          server:
            Project: []
            Session: []
            ImpersonateUserId: []
      security:
      - Project: []
        Session: []
        Key: []
        JWT: []
      - Project: []
        Session: []
        Key: []
        JWT: []
        ImpersonateUserId: []
      parameters:
      - name: code
        description: Browser Code.
        required: true
        schema:
          type: string
          example: aa
          title: Browser
          oneOf:
          - type: string
            enum:
            - aa
            title: Avant Browser
          - type: string
            enum:
            - an
            title: Android WebView Beta
          - type: string
            enum:
            - ch
            title: Google Chrome
          - type: string
            enum:
            - ci
            title: Google Chrome (iOS)
          - type: string
            enum:
            - cm
            title: Google Chrome (Mobile)
          - type: string
            enum:
            - cr
            title: Chromium
          - type: string
            enum:
            - ff
            title: Mozilla Firefox
          - type: string
            enum:
            - sf
            title: Safari
          - type: string
            enum:
            - mf
            title: Mobile Safari
          - type: string
            enum:
            - ps
            title: Microsoft Edge
          - type: string
            enum:
            - oi
            title: Microsoft Edge (iOS)
          - type: string
            enum:
            - om
            title: Opera Mini
          - type: string
            enum:
            - op
            title: Opera
          - type: string
            enum:
            - 'on'
            title: Opera (Next)
        in: path
      - name: width
        description: Image width. Pass an integer between 0 to 2000. Defaults to 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 0
          default: 100
        in: query
      - name: height
        description: Image height. Pass an integer between 0 to 2000. Defaults to 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 0
          default: 100
        in: query
      - name: quality
        description: Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
        required: false
        schema:
          type: integer
          format: int32
          example: -1
          default: -1
        in: query
  /avatars/credit-cards/{code}:
    get:
      summary: Get credit card icon
      operationId: avatarsGetCreditCard
      tags:
      - avatars
      description: 'The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.


        When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

        '
      responses:
        '200':
          description: Image
          content:
            image/png:
              schema:
                type: string
                format: binary
      deprecated: false
      x-appwrite:
        group: null
        demo: avatars/get-credit-card.md
        rate-limit: 0
        rate-time: 3600
        rate-key: url:{url},ip:{ip}
        scope: avatars.read
        platforms:
        - console
        - client
        - server
        packaging: false
        public: true
        auth:
          console:
            Project: []
            ImpersonateUserId: []
          client:
            Project: []
            ImpersonateUserId: []
          server:
            Project: []
            Session: []
            ImpersonateUserId: []
      security:
      - Project: []
        Session: []
        Key: []
        JWT: []
      - Project: []
        Session: []
        Key: []
        JWT: []
        ImpersonateUserId: []
      parameters:
      - name: code
        description: 'Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.'
        required: true
        schema:
          type: string
          example: amex
          title: CreditCard
          oneOf:
          - type: string
            enum:
            - amex
            title: American Express
          - type: string
            enum:
            - argencard
            title: Argencard
          - type: string
            enum:
            - cabal
            title: Cabal
          - type: string
            enum:
            - cencosud
            title: Cencosud
          - type: string
            enum:
            - diners
            title: Diners Club
          - type: string
            enum:
            - discover
            title: Discover
          - type: string
            enum:
            - elo
            title: Elo
          - type: string
            enum:
            - hipercard
            title: Hipercard
          - type: string
            enum:
            - jcb
            title: JCB
          - type: string
            enum:
            - mastercard
            title: Mastercard
          - type: string
            enum:
            - naranja
            title: Naranja
          - type: string
            enum:
            - targeta-shopping
            title: Tarjeta Shopping
          - type: string
            enum:
            - unionpay
            title: Union Pay
          - type: string
            enum:
            - visa
            title: Visa
          - type: string
            enum:
            - mir
            title: MIR
          - type: string
            enum:
            - maestro
            title: Maestro
          - type: string
            enum:
            - rupay
            title: Rupay
        in: path
      - name: width
        description: Image width. Pass an integer between 0 to 2000. Defaults to 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 0
          default: 100
        in: query
      - name: height
        description: Image height. Pass an integer between 0 to 2000. Defaults to 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 0
          default: 100
        in: query
      - name: quality
        description: Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
        required: false
        schema:
          type: integer
          format: int32
          example: -1
          default: -1
        in: query
  /avatars/favicon:
    get:
      summary: Get favicon
      operationId: avatarsGetFavicon
      tags:
      - avatars
      description: 'Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.


        This endpoint does not follow HTTP redirects.'
      responses:
        '200':
          description: Image
          content:
            image/*:
              schema:
                type: string
                format: binary
      deprecated: false
      x-appwrite:
        group: null
        demo: avatars/get-favicon.md
        rate-limit: 0
        rate-time: 3600
        rate-key: url:{url},ip:{ip}
        scope: avatars.read
        platforms:
        - console
        - client
        - server
        packaging: false
        public: true
        auth:
          console:
            Project: []
            ImpersonateUserId: []
          client:
            Project: []
            ImpersonateUserId: []
          server:
            Project: []
            Session: []
            ImpersonateUserId: []
      security:
      - Project: []
        Session: []
        Key: []
        JWT: []
      - Project: []
        Session: []
        Key: []
        JWT: []
        ImpersonateUserId: []
      parameters:
      - name: url
        description: Website URL which you want to fetch the favicon from.
        required: true
        schema:
          type: string
          format: url
          example: https://example.com
        in: query
  /avatars/flags/{code}:
    get:
      summary: Get country flag
      operationId: avatarsGetFlag
      tags:
      - avatars
      description: 'You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard.


        When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.

        '
      responses:
        '200':
          description: Image
          content:
            image/png:
              schema:
                type: string
                format: binary
      deprecated: false
      x-appwrite:
        group: null
        demo: avatars/get-flag.md
        rate-limit: 0
        rate-time: 3600
        rate-key: url:{url},ip:{ip}
        scope: avatars.read
        platforms:
        - console
        - client
        - server
        packaging: false
        public: true
        auth:
          console:
            Project: []
            ImpersonateUserId: []
          client:
            Project: []
            ImpersonateUserId: []
          server:
            Project: []
            Session: []
            ImpersonateUserId: []
      security:
      - Project: []
        Session: []
        Key: []
        JWT: []
      - Project: []
        Session: []
        Key: []
        JWT: []
        ImpersonateUserId: []
      parameters:
      - name: code
        description: Country Code. ISO Alpha-2 country code format.
        required: true
        schema:
          type: string
          example: af
          title: Flag
          oneOf:
          - type: string
            enum:
            - af
            title: Afghanistan
          - type: string
            enum:
            - ao
            title: Angola
          - type: string
            enum:
            - al
            title: Albania
          - type: string
            enum:
            - ad
            title: Andorra
          - type: string
            enum:
            - ae
            title: United Arab Emirates
          - type: string
            enum:
            - ar
            title: Argentina
          - type: string
            enum:
            - am
            title: Armenia
          - type: string
            enum:
            - ag
            title: Antigua and Barbuda
          - type: string
            enum:
            - au
            title: Australia
          - type: string
            enum:
            - at
            title: Austria
          - type: string
            enum:
            - az
            title: Azerbaijan
          - type: string
            enum:
            - bi
            title: Burundi
          - type: string
            enum:
            - be
            title: Belgium
          - type: string
            enum:
            - bj
            title: Benin
          - type: string
            enum:
            - bf
            title: Burkina Faso
          - type: string
            enum:
            - bd
            title: Bangladesh
          - type: string
            enum:
            - bg
            title: Bulgaria
          - type: string
            enum:
            - bh
            title: Bahrain
          - type: string
            enum:
            - bs
            title: Bahamas
          - type: string
            enum:
            - ba
            title: Bosnia and Herzegovina
          - type: string
            enum:
            - by
            title: Belarus
          - type: string
            enum:
            - bz
            title: Belize
          - type: string
            enum:
            - bo
            title: Bolivia
          - type: string
            enum:
            - br
            title: Brazil
          - type: string
            enum:
            - bb
            title: Barbados
          - type: string
            enum:
            - bn
            title: Brunei Darussalam
          - type: string
            enum:
            - bt
            title: Bhutan
          - type: string
            enum:
            - bw
            title: Botswana
          - type: string
            enum:
            - cf
            title: Central African Republic
          - type: string
            enum:
            - ca
            title: Canada
          - type: string
            enum:
            - ch
            title: Switzerland
          - type: string
            enum:
            - cl
            title: Chile
          - type: string
            enum:
            - cn
            title: China
          - type: string
            enum:
            - ci
            title: Côte d'Ivoire
          - type: string
            enum:
            - cm
            title: Cameroon
          - type: string
            enum:
            - cd
            title: Democratic Republic of the Congo
          - type: string
            enum:
            - cg
            title: Republic of the Congo
          - type: string
            enum:
            - co
            title: Colombia
          - type: string
            enum:
            - km
            title: Comoros
          - type: string
            enum:
            - cv
            title: Cape Verde
          - type: string
            enum:
            - cr
            title: Costa Rica
          - type: string
            enum:
            - cu
            title: Cuba
          - type: string
            enum:
            - cy
            title: Cyprus
          - type: string
            enum:
            - cz
            title: Czech Republic
          - type: string
            enum:
            - de
            title: Germany
          - type: string
            enum:
            - dj
            title: Djibouti
          - type: string
            enum:
            - dm
            title: Dominica
          - type: string
            enum:
            - dk
            title: Denmark
          - type: string
            enum:
            - do
            title: Dominican Republic
          - type: string
            enum:
            - dz
            title: Algeria
          - type: string
            enum:
            - ec
            title: Ecuador
          - type: string
            enum:
            - eg
            title: Egypt
          - type: string
            enum:
            - er
            title: Eritrea
          - type: string
            enum:
            - es
            title: Spain
          - type: string
            enum:
            - ee
            title: Estonia
          - type: string
            enum:
            - et
            title: Ethiopia
          - type: string
            enum:
            - fi
            title: Finland
          - type: string
            enum:
            - fj
            title: Fiji
          - type: string
            enum:
            - fr
            title: France
          - type: string
            enum:
            - fm
            title: Micronesia (Federated States of)
          - type: string
            enum:
            - ga
            title: Gabon
          - type: string
            enum:
            - gb
            title: United Kingdom
          - type: string
            enum:
            - ge
            title: Georgia
          - type: string
            enum:
            - gh
            title: Ghana
          - type: string
            enum:
            - gn
            title: Guinea
          - type: string
            enum:
            - gm
            title: Gambia
          - type: string
            enum:
            - gw
            title: Guinea-Bissau
          - type: string
            enum:
            - gq
            title: Equatorial Guinea
          - type: string
            enum:
            - gr
            title: Greece
          - type: string
            enum:
            - gd
            title: Grenada
          - type: string
            enum:
            - gt
            title: Guatemala
          - type: string
            enum:
            - gy
            title: Guyana
          - type: string
            enum:
            - hn
            title: Honduras
          - type: string
            enum:
            - hr
            title: Croatia
          - type: string
            enum:
            - ht
            title: Haiti
          - type: string
            enum:
            - hu
            title: Hungary
          - type: string
            enum:
            - id
            title: Indonesia
          - type: string
            enum:
            - in
            title: India
          - type: string
            enum:
            - ie
            title: Ireland
          - type: string
            enum:
            - ir
            title: Iran (Islamic Republic of)
          - type: string
            enum:
            - iq
            title: Iraq
          - type: string
            enum:
            - is
            title: Iceland
          - type: string
            enum:
            - il
            title: Israel
          - type: string
            enum:
            - it
            title: Italy
          - type: string
            enum:
            - jm
            title: Jamaica
          - type: string
            enum:
            - jo
            title: Jordan
          - type: string
            enum:
            - jp
            title: Japan
          - type: string
            enum:
            - kz
            title: Kazakhstan
          - type: string
            enum:
            - ke
            title: Kenya
          - type: string
            enum:
            - kg
            title: Kyrgyzstan
          - type: string
            enum:
            - kh
            title: Cambodia
          - type: string
            enum:
            - ki
            title: Kiribati
          - type: string
            enum:
            - kn
            title: Saint Kitts and Nevis
          - type: string
            enum:
            - kr
            title: South Korea
          - type: string
            enum:
            - kw
            title: Kuwait
          - type: string
            enum:
            - la
            title: Lao People's Democratic Republic
          - type: string
            enum:
            - lb
            title: Lebanon
          - type: string
            enum:
            - lr
            title: Liberia
          - type: string
            enum:
            - ly
            title: Libya
          - type: string
            enum:
            - lc
            title: Saint Lucia
          - type: string
            enum:
            - li
            title: Liechtenstein
          - type: string
            enum:
            - lk
            title: Sri Lanka
          - type: string
            enum:
            - ls
            title: Lesotho
          - type: string
            enum:
            - lt
            title: Lithuania
          - type: string
            enum:
            - lu
            title: Luxembourg
          - type: string
            enum:
            - lv
            title: Latvia
          - type: string
            enum:
            - ma
            title: Morocco
          - type: string
            enum:
            - mc
            title: Monaco
          - type: string
            enum:
            - md
            title: Moldova
          - type: string
            enum:
            - mg
            title: Madagascar
          - type: string
            enum:
            - mv
            title: Maldives
          - type: string
            enum:
            - mx
            title: Mexico
          - type: string
            enum:
            - mh
            title: Marshall Islands
          - type: string
            enum:
            - mk
            title: North Macedonia
          - type: string
            enum:
            - ml
            title: Mali
          - type: string
            enum:
            - mt
            title: Malta
          - type: string
            enum:
            - mm
            title: Myanmar
          - type: string
            enum:
            - me
            title: Montenegro
          - type: string
            enum:
            - mn
            title: Mongolia
          - type: string
            enum:
            - mz
            title: Mozambique
          - type: string
            enum:
            - mr
            title: Mauritania
          - type: string
            enum:
            - mu
            title: Mauritius
          - type: string
            enum:
            - mw
            title: Malawi
          - type: string
            enum:
            - my
            title: Malaysia
          - type: string
            enum:
            - na
            title: Namibia
          - type: string
            enum:
            - ne
            title: Niger
          - type: string
            enum:
            - ng
            title: Nigeria
          - type: string
            enum:
            - ni
            title: Nicaragua
          - type: string
            enum:
            - nl
            title: Netherlands
          - type: string
            enum:
            - 'no'
            title: Norway
          - type: string
            enum:
            - np
            title: Nepal
          - type: string
            enum:
            - nr
            title: Nauru
          - type: string
            enum:
            - nz
            title: New Zealand
          - type: string
            enum:
            - om
            title: Oman
          - type: string
            enum:
            - pk
            title: Pakistan
          - type: string
            enum:
            - pa
            title: Panama
          - type: string
            enum:
            - pe
            title: Peru
          - type: string
            enum:
            - ph
            title: Philippines
          - type: string
            enum:
            - pw
            title: Palau
          - type: string
            enum:
            - pg
            title: Papua New Guinea
          - type: string
            enum:
            - pl
            title: Poland
          - type: string
            enum:
            - pf
            title: French Polynesia
          - type: string
            enum:
            - kp
            title: North Korea
          - type: string
            enum:
            - pt
            title: Portugal
          - type: string
            enum:
            - py
            title: Paraguay
          - type: string
            enum:
            - qa
            title: Qatar
          - type: string
            enum:
            - ro
            title: Romania
          - type: string
            enum:
            - ru
            title: Russia
          - type: string
            enum:
            - rw
            title: Rwanda
          - type: string
            enum:
            - sa
            title: Saudi Arabia
          - type: string
            enum:
            - sd
            title: Sudan
          - type: string
            enum:
            - sn
            title: Senegal
          - type: string
            enum:
            - sg
            title: Singapore
          - type: string
            enum:
            - sb
            title: Solomon Islands
          - type: string
            enum:
            - sl
            title: Sierra Leone
          - type: string
            enum:
            - sv
            title: El Salvador
          - type: string
            enum:
            - sm
            title: San Marino
          - type: string
            enum:
            - so
            title: Somalia
          - type: string
            enum:
            - rs
            title: Serbia
          - type: string
            enum:
            - ss
            title: South Sudan
          - type: string
            enum:
            - st
            title: Sao Tome and Principe
          - type: string
            enum:
            - sr
            title: Suriname
          - type: string
            enum:
            - sk
            title: Slovakia
          - type: string
            enum:
            - si
            title: Slovenia
          - type: string
            enum:
            - se
            title: Sweden
          - type: string
            enum:
            - sz
            title: Eswatini
          - type: string
            enum:
            - sc
            title: Seychelles
          - type: string
            enum:
            - sy
            title: Syria
          - type: string
            enum:
            - td
            title: Chad
          - type: string
            enum:
            - tg
            title: Togo
          - type: string
            enum:
            - th
            title: Thailand
          - type: string
            enum:
            - tj
            title: Tajikistan
          - type: string
            enum:
            - tm
            title: Turkmenistan
          - type: string
            enum:
            - tl
            title: Timor-Leste
          - type: string
            enum:
            - to
            title: Tonga
          - type: string
            enum:
            - tt
            title: Trinidad and Tobago
          - type: string
            enum:
            - tn
            title: Tunisia
          - type: string
            enum:
            - tr
            title: Turkey
          - type: string
            enum:
            - tv
            title: Tuvalu
          - type: string
            enum:
            - tz
            title: Tanzania
          - type: string
            enum:
            - ug
            title: Uganda
          - type: string
            enum:
            - ua
            title: Ukraine
          - type: string
            enum:
            - uy
            title: Uruguay
          - type: string
            enum:
            - us
            title: United States
          - type: string
            enum:
            - uz
            title: Uzbekistan
          - type: string
            enum:
            - va
            title: Vatican City
          - type: string
            enum:
            - vc
            title: Saint Vincent and the Grenadines
          - type: string
            enum:
            - ve
            title: Venezuela
          - type: string
            enum:
            - vn
            title: Vietnam
          - type: string
            enum:
            - vu
            title: Vanuatu
          - type: string
            enum:
            - ws
            title: Samoa
          - type: string
            enum:
            - ye
            title: Yemen
          - type: string
            enum:
            - za
            title: South Africa
          - type: string
            enum:
            - zm
            title: Zambia
          - type: string
            enum:
            - zw
            title: Zimbabwe
        in: path
      - name: width
        description: Image width. Pass an integer between 0 to 2000. Defaults to 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 0
          default: 100
        in: query
      - name: height
        description: Image height. Pass an integer between 0 to 2000. Defaults to 100.
        required: false
        schema:
          type: integer
          format: int32
          example: 0
          default: 100
        in: query
      - name: quality
        description: Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.
        required: false
        schema:
          type: integer
          format: int32
          example: -1
          default: -1
        in: query
  /avatars/image:
    get:
      summary: Get image from URL
      operationId: avatarsGetImage
      tags:
      - avatars
      description: 'Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.


        When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.


        This endpoint does not follow HTTP redirects.'
      responses:
        '200':
          description: Image
          content:
            image/*:
              schema:
                type: string
                format: binary
      deprecated: false
      x-appwrite:
        group: null
        demo: avatars/get-image.md
        rate-limit: 0
        rate-time: 3600
        rate-key: url:{url},ip:{ip}
        scope: avatars.read
        platforms:
        - console
        - client
        - server
        packaging: false
        public: true
        auth:
          console:
            Project: []
            ImpersonateUserId: []
          client:
            Project: []
            ImpersonateUserId: []
          server:
            Project: []
            Session: []
            ImpersonateUserId: []
      security:
      - Project: []
        Session: []
        Key: []
        JWT: []
      - Project: []
        Session: []
        Key: []
        JWT:

# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-avatars-api-openapi.yml