Quickstart

This walks through the API with curl. Set your key first:

export AVINA_API_KEY="<your workspace API key>"

Create an API key

In the Avina dashboard, go to Settings → API Keys and click Create API Key (workspace admins only). Copy the key; it is shown once.Check it works:

curl https://api.avina.io/v1/me -H "Authorization: Bearer $AVINA_API_KEY"

The response names the workspace the key belongs to.

Check your credits

curl https://api.avina.io/v1/usage -H "Authorization: Bearer $AVINA_API_KEY"

The response has the current billing period and its credits_used, credits_limit and credits_remaining, the same numbers the dashboard shows.

Create a persona

A persona tells Avina which contacts to look for at each company: the job titles, how many contacts per company (1–100), where the contacts are located (contact_countries, omitted for worldwide), and whether to enrich emails and phones.

curl -X POST https://api.avina.io/v1/personas \
  -H "Authorization: Bearer $AVINA_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: sales-leaders-1" \
  -d '{
    "name": "Sales leaders",
    "job_titles": ["VP Sales", "CRO", "Head of Sales"],
    "contacts_per_company": 2
  }'

The persona appears in the dashboard too. Creating or changing a persona does not search for contacts or use credits.

Change it

Send only the fields to change; job_titles replaces the whole list:

curl -X PATCH https://api.avina.io/v1/personas/$PERSONA_ID \
  -H "Authorization: Bearer $AVINA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "job_titles": ["VP Sales", "CRO"] }'

Getting started

Account

Personas