API Reference

💻

API

Search…

Introduction

Development Quickstart

Сluster URL structure

API Reference

False Alarm Filtering (FAF)

Counting

People Search

Solutions

API Reference

API keys
Traces authenticates your API requests using your account’s API keys.  Making an API request that doesn't include your key, includes incorrect or outdated key returns an error. If you don’t have a valid API Key contact your Traces Account Manager.
Test and Prod Keys
There are separate keys for testing and production workloads. All data submitted with a Test API key is removed automatically within 5 days and can not be restored. Auto Training Pipeline is not initiated with Test API calls. Use test API keys during the development and Prod API keys from production workloads.
Keeping your API keys safe 
Your API key can be used to make any API call on behalf of your account. 
Keep your API key as secure as any other password. 
Keep your API key out of your version control system. 
Share your API key only with those who need it.
Use secret management services and password managers
Should you think your API key has been compromised, contact your Traces Account Manager immediately.
HTTP response codes
Traces uses conventional HTTP response codes to indicate the success or failure of an API request.
 Codes in the 2xx range indicate success. 
Codes in the 4xx range indicate an error that failed given the information provided. 
Codes in the 5xx range indicate an error with the computation cluster.
HTTP Code
Status
Explanation
200
OK
Everything worked as expected
400
Bad Request
The request was unacceptable, often due to missing a required parameter.
401
Unauthorized
The parameters were valid but the request failed.
402
Request Failed
The API key doesn't have permission to perform the request.
403
Forbidden
The API key doesn't have permission to perform the request.
404
Not Found
The requested resource doesn't exist.
429
Too Many Requests
Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
500, 502, 503, 504 
Server Errors
Cluster encountered an unexpected condition that prevented it from fulfilling the request
​

Сluster URL structure

False Alarm Filtering (FAF)

Last modified 1yr ago

Copy link

Outline

API keys

Test and Prod Keys

Keeping your API keys safe

HTTP response codes