Is there a VerifyAI Python SDK?

No. VerifyAI is a plain HTTPS/JSON API, so requests or httpx is all you need and the examples on this page are the whole integration. For in-app camera capture, use the React Native or Flutter SDK.

How do I use it from Django?

Call the API from a view or a background task with requests, exactly as in the quick start. For webhooks, read request.body (the raw bytes) in a csrf_exempt view and run the same verify_verifyai_signature check as the Flask receiver before parsing the JSON.

How do I verify webhook signatures?

Take t and v1 from X-VerifyAI-Signature, compute HMAC-SHA256 of t + '.' + the raw body bytes with your signing secret, and compare it to v1 with hmac.compare_digest. Read the raw body (request.get_data() in Flask), not parsed JSON, reject a t more than five minutes from your clock, and deduplicate on X-VerifyAI-Delivery.

How should I retry failed requests?

Retry 429 and 5xx responses with backoff, wait the Retry-After seconds on a 429, and reuse one Idempotency-Key across a request's retries so the check runs once. Other 4xx responses won't succeed on retry; fix the request instead.

Can I check many photos at once?

Each photo is its own request, so run them in a loop or a thread or asyncio pool sized to your rate limit (100 requests per minute by default). A stable Idempotency-Key per file makes a rerun after a crash safe.

VerifyAI Python Integration

Call the VerifyAI REST API from Python with requests, or httpx when you need async. There is no VerifyAI package to install: the examples below are plain HTTPS, and the Flask webhook receiver is run against real signed deliveries in our test suite.

Try Live Demo Contact Sales

Quick Start

1. Install

bash

# No VerifyAI package: any HTTP client works.
pip install requests        # or httpx for async
export VERIFY_AI_KEY=vai_your_api_key

2. Use

python

import json
import os

import requests

with open("photo.jpg", "rb") as photo:
    res = requests.post(
        "https://verify.switchlabs.dev/api/v1/verify",
        headers={"X-API-Key": os.environ["VERIFY_AI_KEY"]},
        files={"image": ("photo.jpg", photo, "image/jpeg")},
        data={"policy": "scooter_parking", "metadata": json.dumps({"trip_id": "trip_123"})},
        timeout=30,
    )
res.raise_for_status()
result = res.json()

if result["is_compliant"]:
    print("Verified:", result["id"])
else:
    print("Issue:", result["feedback"], result["violation_reasons"])

Features

Plain HTTPS

One POST to /api/v1/verify with an X-API-Key header. Use requests, httpx, aiohttp or urllib, with nothing VerifyAI-specific to install or upgrade.

Sync or Async

requests for scripts and workers; httpx.AsyncClient for FastAPI and other asyncio services. The request is identical.

Any Framework

Flask, Django, FastAPI or a batch job: VerifyAI is an HTTP call, so it fits wherever you already make one.

Multipart or JSON

Upload the file as multipart, or send base64 in a JSON body when the image reached your server that way.

Idempotent Retries

Send an Idempotency-Key header and a retried request returns the original result instead of running, and billing, the check twice.

Tested Webhook Receiver

Verify X-VerifyAI-Signature over the raw body with hmac and hashlib. The Flask receiver below runs against real signed deliveries in our test suite.

Code Examples

Requirements

Python 3.8 or higher
requests (or httpx for async)
A VerifyAI API key (vai_…), kept on your server
Your webhook signing secret (whsec_…) for the receiver

Frequently Asked Questions

Start Building with Python

Get an API key and verify your first photo with a single requests call.