.. _api:


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 :menuselection:`Settings -> API Documentation` in the web interface.

.. toctree::
   :maxdepth: 2
   :caption: Contents
   
   api_overview
   api_getting_started
   api_authentication
   api_watch_lists
   api_cards
   api_detect
   api_object
   api_videos
   api_camera_group
   api_camera
   api_search_objects
   api_compare