Skip to main content

Large Footage Download: Using API

Updated this week

Spot AI is not legally able to extract footage on a customer's behalf.

  1. Create an API key from the dashboard and assign ownership to the key.

  2. Copy the API key once it is generated.

    • If you forgot to copy it, delete the existing key and create a new one.

  3. Copy the token and paste it at bearer under the credentials shown below: Under Admin>>Configure>>API >>Documentation and usage under historical footage, OR use this link and go to Historical footage

4: Create a Historical Footage Job

  • Create a historical footage job by providing:

    • The camera ID ( Camera IDs are found on the dashboard admin>>devices>>click on camera of your interest )

    • The start and end date in ISO format on left

      • Example: 2023-06-29T10:20:05.533Z

  • Run the API request.

    • This will generate a footage ID (for example: 816).

  • Copy that footage ID for use in the next step.

5. Get Details of a Submitted Historical Footage Request

  • Use this endpoint to view the status and progress of the historical footage creation.

  • Enter the following on the left panel:

    • Camera ID

    • Footage ID

This will show whether the footage job is still processing or has completed

you can retry the request in order to see updated progress.

  • The state of the footage job will be shown as processing while it is being generated.

  • You will also see a progress percentage indicating how much of the footage has been created.

    • Example: 48.94%

6. Once the footage reaches 100%, an objectpath will be generated for the requested camera ID. Copy the objectpath and paste it into your browser to access the footage.

7. Once you paste the objectpath into your browser, the footage may initially show as buffering.

  • Give it 5–10 minutes to load if you want to view it directly in the browser.

  • Alternatively, click the three dots on the right and select Download to save the footage locally to your machine.

Footage download Limitation

  • These footage pulls can, and do, put a strain on the your bandwidth. If bandwidth usage is a concern, try to do the retrievals on off-peak times.

  • Scheduling multiple clip exports from the same appliance will slow down the exports themselves.

  • Appliances can only have a combined total of two VOD exports, of up to a max of 100 hours each, accessing the historical footage API at a time to limit strain on the IVR. If there are multiple cameras needed, process them no more than two at a time.

  • Footage is stored for 7 days before it is rotated out.

Did this answer your question?