Docs/Getting started/Quickstart

Real avatars in 90 seconds.

No SDK, no migration, no schema change. You'll add one URL and watch your people rows fill in. Below is the literal copy-and-paste path.

Free preview · no card~120ms median1,000 free requests / month

Create a publishable key

From the console, open API Keys and create a new key. Publishable keys are prefixed pk_ and are safe to ship in a browser <img> tag. Lock them to your domains in the key's settings so nobody else can hot-link your quota.

shellNo code needed — copy from console

# Publishable keys look like this — safe for the browser:
pk_live_7f3e21bc94aa…

Add one image URL

Drop the URL into any place your product renders a user: the row in your CRM, the assignee chip, the comment header. Pass either linkedin_url (full URL) or username (LinkedIn handle).

HTML

<img
  src="https://avtrz.dev/v1/avatar?key={PK_KEY}&linkedin_url={URL}&size=128"
  width="64" height="64"
  alt=""
/>

302 → image/webp · cache-control: public, max-age=86400

Watch the row fill in

On the first request Avtrz finds the photo and 302-redirects the browser to a CDN URL (~120ms). Every subsequent request to the same profile is a CDN hit. You don't have to think about caching: we do.

That's it. Three steps, one URL.

You can stop reading. Or keep going if you want to understand how it works, move the key to your server with secret authentication, or see every option on the endpoint page.

Common options

Three params cover every integration. Full details on the reference page.

Name	Type		Description
key	string	Required	Your publishable (`pk_`) or secret (`sk_`) API key.
linkedin_url	string	Optional	Full LinkedIn profile URL. One of `linkedin_url` or `username` is required.
username	string	Optional	LinkedIn handle (the path segment after `/in/`). Used when you don't have the full URL.
size	enum · 32\|64\|128\|256\|512	Optional	Output square side, in pixels. Defaults to `128`.

Where to go next

How it works

The four-stage lookup: match, decode, encode, cache. Where photos come from, and what doesn't ever leave the edge.

Authentication

Move the lookup to your server with a secret key. Rotate keys safely. Scope by domain.

Overview

Authentication