Skip to main content

​
AI and agents

deepface.dev publishes agent-facing docs through Mintlify and the public API contract.

​
Start with the machine-readable docs

  • https://docs.deepface.dev/llms.txt
  • https://docs.deepface.dev/llms-full.txt
  • https://docs.deepface.dev/skill.md
  • https://docs.deepface.dev/mcp (configured; validate after deploy before relying on it in production)
These surfaces are the preferred entrypoints for coding agents and assistants that need deepface.dev docs, examples, and API tools. Mintlify MCP should be treated as deployment-validated only after a hosted handshake succeeds.
  1. Read GET /capabilities before choosing a model or detector.
  2. Use POST /verify, POST /represent, or POST /compare for compute work.
  3. Send x-request-id on every request you may need to debug later.
  4. Log the echoed x-request-id, status code, and retry headers.

​
Authentication for agents

  • Create an account at deepface.dev/signup.
  • Create an API key in the dashboard after sign-in.
  • Send the key with either Authorization: Bearer YOUR_API_KEY or x-api-key: YOUR_API_KEY.

​
Retry and backoff guidance

  • 429 rate_limited: back off using Retry-After and the RateLimit-* headers.
  • 503 queue_full and 503 queue_timeout: treat as temporary capacity pressure and retry with backoff.
  • 502 upstream_failed and 504 upstream_timeout: retry only after reducing payload size or request concurrency if failures persist.

​
Safe automation boundaries

  • Safe to automate: capability discovery, verification, embedding generation, vector comparison, and account-side key rotation by a signed-in user.
  • Do not automate: scraping the public tester, credential sharing, bypassing rate limits, or sending models/detectors that are not in the current allowlist.
  • Always re-check the active model and detector allowlists before switching models in production automation.