Skip to content

Process

Allows the user to start processing a source. Each process is uniquely identified with an uuid, which may be used to control it by pausing, resuming or stopping. A list of the running processes can also be obtained. The process uuid is also needed for connecting that process to an specific output.

To process a source, the user must use the endpoint POST /start with the source_uuid as argument:

curl -X 'POST' \
  'https://atr.senseaeronautics.com/start?source_uuid=f391286c-836a-4491-bc73-49b7b72d91f7' \
  -H 'accept: application/json' \
  -H 'api_key: api_key' \
  -d ''

If the post is successful (i.e status code 201), you will receive a response like this:

{
  "process_uuid": "fb513143-c554-49b1-8ef3-160a8086654e",
  "feed_url": "https://atr.senseaeronautics.com/process/fb513143-c554-49b1-8ef3-160a8086654e/feed?api_key=api_key",
  "detection_data_url": "https://atr.senseaeronautics.com/process/fb513143-c554-49b1-8ef3-160a8086654e/detection_data?api_key=api_key",
  "telemetry_url": "Not configured"
}

If there is an error during starting the process, the API will respond with different status code:

  • 400 - Source is not live.
  • 403 - Incorrect api_key, simultaneous active processes limit reached, usage limit etc.
  • 404 - Source not found in the database, source file not found locally
  • 503 - Error starting detection pipeline, error starting capture pipeline