Python

:::caution Pré-release (alpha) Este SDK está em alpha (0.1.0-alpha.1). A superfície de API pública ainda está sendo estabilizada — não use em produção. :::

Instalação

pip install velix-sdk

Quickstart

import os
from velix import VelixClient
from velix.modules.checkin import CheckinModule
from velix.modules.persons import PersonsModule

with VelixClient(
    api_url=os.environ["VELIX_API_URL"],
    api_key=os.environ["VELIX_API_KEY"],
) as client:
    persons = PersonsModule(client)
    checkin = CheckinModule(client)

    person = persons.create({"name": "João Silva", "document": "000.000.000-00"})
    persons.enroll(person["id"], foto_base64)

    result = checkin.facial("tenant-slug", frame_base64)
    print(result["passed"])  # True | False

Requisitos

• Python 3.11 ou 3.12 (3.14 não é suportado — onnxruntime não tem wheel)

Variáveis de ambiente

Variável	Obrigatória	Descrição
VELIX_API_URL	Sim	URL base da API
VELIX_API_KEY	Sim	API key do tenant