Skip to main content
POST
/
v1
/
assets
Create asset
curl --request POST \
  --url https://api.intrace.ai/v1/assets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "asset_id": "<string>",
  "type": "facility",
  "name": "<string>",
  "role": "<string>",
  "status": "active",
  "attributes": {
    "lat": 123,
    "lng": 123,
    "address": "<string>",
    "country": "<string>",
    "monitoring_radius_km": 123
  },
  "threat_config": {
    "enabled": true,
    "alert_classes": [
      "class_1_situational_awareness"
    ],
    "custom_instructions": "<string>",
    "monitored_event_types": [
      "<string>"
    ],
    "lookback_days": 45
  },
  "physical_threat_config": {
    "enabled": true,
    "alert_classes": [
      "class_1_situational_awareness"
    ],
    "custom_instructions": "<string>",
    "monitored_event_types": [
      "<string>"
    ],
    "max_age_hours_by_category": {}
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "asset_id": "<string>",
  "type": "<string>",
  "name": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "role": "<string>",
  "attributes": {
    "lat": 123,
    "lng": 123,
    "address": "<string>",
    "country": "<string>",
    "monitoring_radius_km": 123
  },
  "threat_config": {
    "enabled": true,
    "alert_classes": [
      "class_1_situational_awareness"
    ],
    "custom_instructions": "<string>",
    "monitored_event_types": [
      "<string>"
    ],
    "lookback_days": 45
  },
  "physical_threat_config": {
    "enabled": true,
    "alert_classes": [
      "class_1_situational_awareness"
    ],
    "custom_instructions": "<string>",
    "monitored_event_types": [
      "<string>"
    ],
    "max_age_hours_by_category": {}
  }
}
Creates one asset.

​
Request Body

FieldTypeRequiredDescription
asset_idstringYesStable client-side identifier
typestringYesAsset type
namestringYesHuman-readable asset name
rolestringNoAsset role or business meaning
statusstringNoDefaults to active
attributesobjectNoCoordinates, address, country, and custom metadata
threat_configobjectNoGeneral monitoring config
physical_threat_configobjectNoPhysical threat evaluation config

​
Example Request

{
  "asset_id": "abuja-residence-1",
  "type": "residence",
  "name": "Abuja Residence",
  "status": "active",
  "attributes": {
    "lat": 9.0765,
    "lng": 7.3986,
    "address": "Central District, Abuja",
    "country": "NG",
    "monitoring_radius_km": 5
  },
  "physical_threat_config": {
    "enabled": true,
    "alert_classes": [
      "class_2_potential_threat",
      "class_3_direct_threat"
    ]
  }
}

​
Example cURL

curl -X POST -H "X-API-Key: your-api-key" -H "Content-Type: application/json" -d @asset.json "https://api.intrace.ai/v1/assets"

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
asset_id
string
required
​
type
enum<string>
required
Available options:
facility,
residence
​
name
string
required
​
role
string
​
status
string
default:active
​
attributes
object
​
threat_config
object
​
physical_threat_config
object

Response

Asset created.

​
id
string<uuid>
required
​
asset_id
string
required
​
type
string
required
​
name
string
required
​
status
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
role
string | null
​
attributes
object
​
threat_config
object
​
physical_threat_config
object