Quickstart

Send your first request to deepface.dev and understand the supported launch flow.

Quickstart

The public API is served by the gateway at https://deepface-cyybxg.fly.dev.

1. Request access

Join the deepface.dev waitlist. During the soft launch, API keys are provisioned for approved testers only.

2. Pick a supported model

Start with Facenet unless you have a compatibility reason to choose another approved model. Review the full models and licensing guide before production use.

3. Call /verify

curl --request POST \
  --url https://deepface-cyybxg.fly.dev/verify \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --form 'img1=@./person-a.jpg' \
  --form 'img2=@./person-b.jpg' \
  --form 'model_name=Facenet'

Example response:

{
  "verified": true,
  "distance": 0.19,
  "threshold": 0.4,
  "model": "Facenet"
}

Runnable examples

• JavaScript verify example
• JavaScript represent example
• JavaScript compare example
• Python verify example
• Python represent example
• Python compare example

4. Inspect capabilities

Use GET /capabilities to read the active model and detector allowlists before rolling requests into production.

5. Keep request IDs

Every compute response includes x-request-id. Log it on your side for support handoffs and incident debugging.