Introduction to the KSI Vision REST APIs
Everything you need to know to start retrieving data from KSI Vision programmatically.
What is a REST API?
A REST API (Representational State Transfer) is a set of rules that allows programs to communicate with each other by exposing data and functionality over HTTP. When you see a reference to a REST API, it typically means a web interface you interact with via URLs using standard HTTP verbs (GET, POST, etc.).
KSI Vision's REST APIs give developers direct access to the platform's analytics, configuration data, and event ingestion - without needing to use the web interface.
Bearer authentication
All requests to the KSI API require authentication using a Bearer Token. Bearer authentication is an HTTP authentication scheme where a security token - generated by the server upon login - must be included in the Authorization header of every request.
Think of it as: "give access to whoever carries this token." The token is cryptographic, scoped to a specific account, and inherits that account's permissions.
To learn how to generate your token, see the Authentication guide.
Exploring the API documentation
Once logged in to the KSI platform, you can access the full interactive API documentation at the following URL:
- Americas: https://la.ksivision.com/api/docs
- Europe: https://eu.ksivision.com/api/docs
The docs list all available endpoints, their expected inputs, and the structure of their responses.
Example: retrieve your Locations
The following request returns a list of all Locations your account has access to. Replace API_TOKEN with your Personal Access Token (see the Authentication guide).
Request
curl -H 'Accept: application/json' \
-H "Authorization: Bearer API_TOKEN" \
https://la.ksivision.com/api/locationsResponse
// Content-Type: application/json
[
{
"id": 0,
"description": "string"
}
]The response is a JSON array of Location objects, each with an id and a description.
