# Shinobi API

Link: [https://docs.shinobi.video/api](https://docs.shinobi.video/api)

# RESTful API

####  Simple and Efficient

Everything that the official dashboard does is through the Shinobi API. Meaning If you decide to build your own user interface or just using certain functions of Shinobi; The API will make quick work of it.

When you authenticate with Shinobi it will offer you an Authorization Token. This token is your Session Key as well and can be used as an API Key. This key will remain active for 15 minutes after the last acivity or while your WebSocket is connected.

####  Let's Begin

Create an API Key or Login to get started.

- [Authentication](https://docs.shinobi.video/api/authentication)
- [Managing API Keys](https://docs.shinobi.video/api/managing-api-keys-ui)

#### After Authentication

<div class="" id="bkmrk-managing-api-keys-by"><div class="" id="bkmrk-managing-api-keys-by-1">[Managing API Keys by UI](https://docs.shinobi.video/api/managing-api-keys-ui)</div><div class=""><span class="text-muted">/api/managing-api-keys-ui</span></div><div class=""></div></div><div class="" id="bkmrk-managing-api-keys-by-2"><div class="" id="bkmrk-managing-api-keys-by-3">[Managing API Keys by API](https://docs.shinobi.video/api/managing-api-keys-api)</div><div class=""><span class="text-muted">/api/managing-api-keys-api</span></div><div class=""></div></div><div class="" id="bkmrk-websocket-connection"><div class="" id="bkmrk-websocket-connection-1">[WebSocket Connection](https://docs.shinobi.video/api/api-connecting-websocket)</div><div class=""><span class="text-muted">/api/api-connecting-websocket</span></div><div class=""></div></div><div class="" id="bkmrk-get-monitors-%2Fapi%2Fge"><div class="" id="bkmrk-get-monitors">[Get Monitors](https://docs.shinobi.video/api/get-monitors)</div><div class=""><span class="text-muted">/api/get-monitors</span></div><div class=""></div></div><div class="" id="bkmrk-get-detection-events"><div class="" id="bkmrk-get-detection-events-1">[Get Detection Events](https://docs.shinobi.video/api/get-events)</div><div class=""><span class="text-muted">/api/get-events</span></div><div class=""></div></div><div class="" id="bkmrk-get-streams-%2Fapi%2Fget"><div class="" id="bkmrk-get-streams">[Get Streams](https://docs.shinobi.video/api/get-streams)</div><div class=""><span class="text-muted">/api/get-streams</span></div><div class=""></div></div><div class="" id="bkmrk-embedding-streams-%2Fa"><div class="" id="bkmrk-embedding-streams">[Embedding Streams](https://docs.shinobi.video/api/embedding-streams)</div><div class=""><span class="text-muted">/api/embedding-streams</span></div></div><div class="" id="bkmrk-get-videos-%2Fapi%2Fget-"><div class="" id="bkmrk-get-videos">  
[Get Videos](https://docs.shinobi.video/api/get-videos)</div><div class=""><span class="text-muted">/api/get-videos</span></div><div class=""></div></div><div class="" id="bkmrk-get-timelapse-%2Fapi%2Fg"><div class="" id="bkmrk-get-timelapse">[Get Timelapse](https://docs.shinobi.video/api/get-timelapse)</div><div class=""><span class="text-muted">/api/get-timelapse</span></div><div class=""></div></div><div class="" id="bkmrk-get-filebin-%2Fapi%2Fget"><div class="" id="bkmrk-get-filebin">[Get FileBin](https://docs.shinobi.video/api/get-fileBin)</div><div class=""><span class="text-muted">/api/get-fileBin</span></div><div class=""></div></div><div class="" id="bkmrk-custom-settings-%2Fapi"><div class="" id="bkmrk-custom-settings">[Custom Settings](https://docs.shinobi.video/api/custom-settings)</div><div class=""><span class="text-muted">/api/custom-settings</span></div><div class=""></div></div><div class="" id="bkmrk-add%2C-edit-or-delete-"><div class="" id="bkmrk-add%2C-edit-or-delete--1">[Add, Edit or Delete a Monitor](https://docs.shinobi.video/api/add-edit-or-delete-a-monitor)</div><div class=""><span class="text-muted">/api/add-edit-or-delete-a-monitor</span></div><div class=""></div></div><div class="" id="bkmrk-modifying-a-video-or"><div class="" id="bkmrk-modifying-a-video-or-1">[Modifying a Video or Deleting it](https://docs.shinobi.video/api/modifying-a-video-or-deleting-it)</div><div class=""><span class="text-muted">/api/modifying-a-video-or-deleting-it</span></div><div class=""></div></div><div class="" id="bkmrk-monitor-triggers-%2Fap"><div class="" id="bkmrk-monitor-triggers">[Monitor Triggers](https://docs.shinobi.video/api/monitor-triggers)</div><div class=""><span class="text-muted">/api/monitor-triggers</span></div><div class=""></div></div><div class="" id="bkmrk-superuser-%2Fapi%2Fsuper"><div class="" id="bkmrk-superuser">[Superuser](https://docs.shinobi.video/api/superuser-only)</div><div class=""><span class="text-muted">/api/superuser-only</span></div><div class=""></div></div><div class="" id="bkmrk-administrator-%2Fapi%2Fa"><div class="" id="bkmrk-administrator">[Administrator](https://docs.shinobi.video/api/administrator-only)</div><div class=""><span class="text-muted">/api/administrator-only</span></div><div class=""></div></div><div class="" id="bkmrk-monitor-presets-%2Fapi"><div class="" id="bkmrk-monitor-presets">[Monitor Presets](https://docs.shinobi.video/api/monitor-states-preset-configurations)</div><div class=""><span class="text-muted">/api/monitor-states-preset-configurations</span></div><div class=""></div></div><div class="" id="bkmrk-schedules-for-monito"><div class="" id="bkmrk-schedules-for-monito-1">[Schedules for Monitor Presets](https://docs.shinobi.video/api/scheduling-for-monitors)</div><div class=""><span class="text-muted">/api/scheduling-for-monitors</span></div><div class=""></div></div><div class="" id="bkmrk-system-%2Fapi%2Fsystem-t"><div class="" id="bkmrk-system">[System](https://docs.shinobi.video/api/system-triggers)</div><div class=""><span class="text-muted">/api/system-triggers</span></div><div class=""></div></div><div class="" id="bkmrk-onvif-management-thr"><div class="" id="bkmrk-onvif-management-thr-1">[ONVIF Management through Shinobi](https://docs.shinobi.video/api/direct-camera-management-via-onvif)</div><div class=""><span class="text-muted">/api/direct-camera-management-via-onvif</span></div></div>