HTTP API

Detailed interactive documentation on the FindFace HTTP API is available after installation at http://<findface-ip:port>/api-docs. Learn and try it out.

Tip

<findface-ip:port> must be substituted into your ip address for FindFace Multi.

Tip

You can also find it by navigating to Settings -> API Documentation in the web interface.

Contents

• Overview
• Getting started
  • Gear Up for Work
  • Organize Watch Lists and Card Index
  • Upload and Process Video File
  • Data Sources
  • FindFace Multi in Action
• Authentication
  • HTTP Basic authentication
  • API Key authorization
• Watch lists
  • List watch lists
  • Create a new watch list
  • Useful requests
• Record
  • Create a new record
  • List records
  • Useful requests
• Detect objects on a photo
• Objects
  • Add face object
  • Useful requests
• Videos
  • List video archives
  • Add a new video archive
  • Upload video file
  • Start video archive processing
  • Useful requests
• Camera groups
  • List camera groups
  • Create Camera Group
  • Useful requests
• Cameras
  • Create a new camera
• Search Faces in System
• Compare Two Faces