Skip to main content

API overview

The managed public API currently exposes five routes:
  • GET /health
  • GET /capabilities
  • POST /verify
  • POST /represent
  • POST /compare

Input modes

  • multipart/form-data for file uploads
  • application/json for base64 payloads
Remote image URLs and local file paths are disabled unless explicitly enabled on the model server.

Generated endpoint docs

The endpoint pages in this section are generated from the bundled OpenAPI document. The canonical source of truth lives in openapi/deepface.openapi.yaml in the repository.