Getting started with the API

Last modified: Tuesday July 01, 2025.

API Endpoint

The base URL of the API service endpoint is constructed using your deployment URL:

https://<deployment URL>/api/v1

For example:

https://test-deployment.eu1.alta.avigilon.com/api/v1/

API Explorer

You can see the available operations in the API Explorer:

• In the Video or Protect web app, click your user initials and select API Explorer.
• Alternatively, go to https://alta-video.readme.io/reference/get_api-v1-about

Recommended skills and knowledge

The following skills and knowledge are recommended to develop applications using the API:

• Basic programming skills.
• Web concepts (HTTP/S).
• Obtaining and using API keys and authentication tokens.
• Data formats and creating data structures, particularly in JSON.
• Programmatically constructing HTTP Requests (HTTP method, URL, headers, request body, and payload).
• Programmatically handling and parsing responses to extract relevant information.
• Configuring event detection using webhooks and gathering and formatting event data.
• Basic security practices, including storage and use of passwords and user IDs.