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
  • authenticated API requests may use public http(s) image URLs when that feature is enabled on the model server
The public tester remains file/base64 only. Local filesystem paths are disabled unless explicitly enabled on the model server.

​
Integration guidance

  • Use GET /capabilities before choosing models or detectors in automation.
  • Use x-request-id for traceability on compute calls.
  • Expect RateLimit-* and Retry-After headers on throttled or retryable responses.

​
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 and also powers the Mintlify MCP surface for agent tooling.