Primeira chamada

Mint uma chave, confirme GET /me e crie o primeiro contato no mesmo workspace.

Conteúdo oficial AivyroAlinhado ao contrato público atual

GET/api/v1/me

Quatro passos. Se o último devolve 200, a integração está viva — mesmo quando o workspace ainda não tem linhas.

No produto: Settings → Developer → Create API key.
Conceda REST, no mínimo Contacts: Write (rest.crm.contacts.write). Write implica read no mesmo recurso.
Copie o segredo aivk_… — aparece uma vez.
Chame o host público com Authorization: Bearer aivk_…

Host

Um host público. Não mande tráfego de integrador para app.aivyro.io (UI) nem para api.internal.aivyro.io (mesh privado).

Confirme a chave

HTTP	Path	Scope
GET	`/api/v1/me`	`aivk_`

GET /api/v1/me

export AIVYRO_API_KEY='aivk_YOUR_KEY'
export AIVYRO_API_BASE='https://api.aivyro.io'

curl -sS "$AIVYRO_API_BASE/api/v1/me" \
  -H "Authorization: Bearer $AIVYRO_API_KEY"

Crie um contato e liste

POST + GET /api/v1/contacts

curl -sS -X POST "$AIVYRO_API_BASE/api/v1/contacts" \
  -H "Authorization: Bearer $AIVYRO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"display_name":"Ada Lovelace","email":"ada@example.com"}'

curl -sS "$AIVYRO_API_BASE/api/v1/contacts" \
  -H "Authorization: Bearer $AIVYRO_API_KEY"

Workspace vazio devolve { "data": [], "next_cursor": null, "has_more": false }. Isso é sucesso. O contato criado aparece em Contatos da mesma organização.

Contrato máquina

GET /api/v1/openapi.json é o contrato de rotas, paginação e erros. Em alguns hosts o endpoint pede a mesma chave Bearer. Se este site e o OpenAPI discordarem, o OpenAPI e o host ganham — e o guia é que deve ser corrigido.