Development Quickstart

Get up and running with our API and start building AI-powered products today.

Working with the latest version of Traces’ AI can begin as soon as you follow these three steps:

Obtain your API keys so Traces can authenticate your API request
Familiarise yourself with the relevant documentation for your product.
Make a test API request to confirm everything is up and running.

Not a developer?

Talk to our Customer Success Engineer to get the most out of our technology without writing any code

Get in touch with the Customer Success Engineer now.

Obtain your API keys

Traces authenticates your API requests using your account’s API keys. If you don’t have a valid API Key contact your Traces Account Manager.

Read relevant documentation

We have documented the most common use cases for our API. If you are our current customer your version of Traces API may be different as we continuously release new versions and tailor functionality for your individual needs. Follow your cluster URL or log in to the Knowledge Сenter to see the latest updates.

Make a test API request

To check that your integration is working correctly, make a test API request using your API key. We’ve pre-filled some code examples for your convenience.

POST http://faf.traces.cloud/api/v1.1/filter-alarm

Headers

Name

Type

Description

X-Traces-API-Key*

string

Authorization API key to access Traces FAF API

Request Body

Name

Type

Description

metadata*

object

A dictionary with the following keys: "event_id", "camera_id", "timestamp"

image_0*

object

frame #1

image_1*

object

frame #2

image_2*

object

frame #3

image_3*

object

frame #4

image_4*

object

frame #5

{
  "alarm_confirmed": true,
  "alarm_confidence": 0.7892204529672106,
  "triggered_by": [
    {
      "object_type": "vehicle",
      "action": "moving",
      "bbox": [
        527,
        400,
        827,
        569
      ],
      "frame_id": 0,
      "direction": null
    },
    {
      "object_type": "vehicle",
      "action": "moving",
      "bbox": [
        122,
        399,
        335,
        536
      ],
      "frame_id": 1,
      "direction": null
    },
    {
      "object_type": "vehicle",
      "action": "moving",
      "bbox": [
        202,
        270,
        325,
        337
      ],
      "frame_id": 2,
      "direction": null
    }
  ]
}

{
  "code": "INVALID_API_KEY",
  "description": "API key was not recognized"
}

Example

curl -X POST "http://faf.traces.cloud/api/v1.1/filter-alarm"
 -H "accept: */*"
 -H "X-Traces-API-Key: YOUR_API_KEY"
 -H "Content-Type: multipart/form-data"
 -F "metadata={ "event_id": "ddf27b34-d3b5-41a5-b2a6-3873a589ec09", "camera_id": "b5271b30-aecd-4897-bc95-ff25c8466b9e", "timestamp": 1585840725 }" -F 
"image_0=@customer_frame0.png;type=image/png" -F "image_1=@customer_frame1.png;type=image/png" -F "image_2=@customer_frame2.png;type=image/png" -F "image_3=@customer_frame3.png;type=image/png" -F "image_4=@customer_frame4.png;type=image/png"

PreviousIntroduction NextСluster URL structure

Last updated 3 years ago

Was this helpful?

{ "alarm_confirmed": true, "alarm_confidence": 0.7892204529672106, "triggered_by": [ { "object_type": "vehicle", "action": "moving", "bbox": [ 527, 400, 827, 569 ], "frame_id": 0, "direction": null }, { "object_type": "vehicle", "action": "moving", "bbox": [ 122, 399, 335, 536 ], "frame_id": 1, "direction": null }, { "object_type": "vehicle", "action": "moving", "bbox": [ 202, 270, 325, 337 ], "frame_id": 2, "direction": null } ] }

curl -X POST "http://faf.traces.cloud/api/v1.1/filter-alarm" -H "accept: */*" -H "X-Traces-API-Key: YOUR_API_KEY" -H "Content-Type: multipart/form-data" -F "metadata={ "event_id": "ddf27b34-d3b5-41a5-b2a6-3873a589ec09", "camera_id": "b5271b30-aecd-4897-bc95-ff25c8466b9e", "timestamp": 1585840725 }" -F "image_0=@customer_frame0.png;type=image/png" -F "image_1=@customer_frame1.png;type=image/png" -F "image_2=@customer_frame2.png;type=image/png" -F "image_3=@customer_frame3.png;type=image/png" -F "image_4=@customer_frame4.png;type=image/png"