Agent

Creates a new agent or updates an existing agent.

This endpoint either creates a new agent or updates an existing one. It should be called at agent startup. Request body: JSON object. Supports deviceSerial or deviceName.

post/v1/agent

Request

  • Base URL: https://api.actionstreamer.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.actionstreamer.com/v1/agent
  • Auth: none declared

Request body

deviceNamestring nullable
deviceSerialstring nullable
agentTypestring nullable
agentVersionstring nullable
agentIndexinteger nullable
processIDinteger nullable

Example request

{
  "deviceName": "WearableDevice",
  "deviceSerial": "10001234",
  "agentType": "Device",
  "agentVersion": "1.0.0",
  "agentIndex": 1,
  "processID": 4321
}

Response

Success

keyinteger
deviceIDinteger
agentTypeIDinteger
agentIndexinteger
currentEventIDinteger
processIDinteger
versionstring nullable
agentNamestring nullable
agentDescriptionstring nullable
recentOutputstring nullable
lastHeardFromDatestring date-time nullable
creationDatestring date-time nullable

Example response

{
  "key": 1,
  "deviceID": 201,
  "agentTypeID": 1,
  "agentIndex": 1,
  "currentEventID": 501,
  "processID": 4321,
  "version": "1.0.0",
  "agentName": "Example value",
  "agentDescription": "Example description",
  "recentOutput": "Agent started successfully.",
  "lastHeardFromDate": "2026-03-30T12:00:00.0000000Z",
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.