Skip to main content

​
API overview

The managed public API currently exposes six routes:
  • GET /health
  • GET /readiness
  • 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 HTTPS image URLs from any domain when remote URL input is enabled on the model server
The homepage shows precomputed examples and makes no live inference requests. Use the signed-in tester for your own files. 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.
  • Use optional X-Request-Priority on synchronous compute calls to order your account’s waiting requests. Lower positive values run first; the default is 1. See request priority for scope and limits.
  • 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.