Nimble REST API (v1)

Download OpenAPI specification:Download

Nimble's REST API (Application Programming Interface) enables users to configure and query analytics workloads executing within Nimble. Behind this API is a software layer that routes data, arbitrates resources and executes Deep Learning and analytics functions to enable enriched business insights at world-class speed.

The latest online documentation can be found here.

What is a REST API?

API is short for "Application Programming Interface". An API is a set of rules that lets programs talk to each other, exposing data and functionality across the Internet in a consistent format.

REST stands for "Representational State Transfer". This is an architectural pattern that describes how distributed systems can expose a consistent interface. When people use the term "REST API", they are generally referring to an API accessed using the HTTP protocol at a predefined set of URLs.

These URLs represent various resources - any information or content accessed at that location, which can be returned as JSON, HTML, or media files. Often resources have one or more methods that can be performed on them over HTTP, like GET, POST, PUT, PATCH, and DELETE. The action represented by the first and last of these is clear, but POST, PUT, and PATCH have specific meanings. How they are defined is confusing, but the general rule is: use POST to create resources, PUT to update resources, and PATCH to modify resources.

The Key Elements of Nimble

Nimble and the REST API have six key categories: Activation, Catalog, Configuration, Exports, Statistics, and About.
Nimble must be activated with a valid license before a configuration can be deployed.
The catalog includes additional resources that may be useful in constructing a configuration.
A Configuration is a collection of Sources, Sinks and Pipeline Elements arranged to execute the desired analytic behavior.
A Source brings data into Nimble.
A Sink pushes data out of Nimble.
A Pipeline is made up of processing elements that perform some analytics task.
Exports are resources managed by Nimble as a output result of a configuration being deployed.
Since a Source can be shared between multiple Pipelines, a Channel is an abstraction of both a Source and a Pipeline that can be thought of as "the data brought in by this Source is operated on by this Pipeline".
A Stream is a proxied fMP4 video stream from a Source.

Activation

Nimble must be activated with a valid license before a configuration can be deployed.

Activate

Activate Nimble with a valid license.

query Parameters

force

boolean

Default: false

Whether to force re-activation of Nimble even if Nimble is already activated with a valid license.

Request Body schema: application/json
required

The license JSON data.

version required	integer <int32> Version of the license. Value: 1
customer required	string Customer ID.
subscription required	string License Subscription ID.
pool required	string License Pool ID.

Responses

Request samples

Payload

Content type

application/json

{"version": 1,
"customer": "ABCDEFGHI",
"subscription": "JKLMNOPQR",
"pool": "STUVWXYZ"
}

Fetch activation status

Retrieve license activation status of Nimble.

Responses

Response samples

200

Content type

application/json

{"activated": true
}

Catalog

A collection of read-only resources that are dynamically loaded and available at runtime. Includes resources such as: Pipeline Elements, Models, and Hardware Devices.

Fetch Catalog

Retrieve all catalog resources that are available from Nimble.

query Parameters

filter	Array of strings Items Enum: "elements" "models" "devices" Specify the top-level resource types to retrieve.
filter-models	Array of strings Default: "devices" Items Enum: "devices" "none" Specify by which method(s) to filter the models.

Responses

Response samples

200

Content type

application/json

{"elements": [{"name": "infer",
"title": "Infer",
"params_schema": {"type": "object",
"properties": {"model": {"description": "The name of the model to use for inference.",
"type": "string"
},
"hw": {"description": "The type of hardware device to use to run the model.",
"type": "string",
"enum": ["auto",
"cpu",
"igpu",
"gpu"
],
"default": "auto"
},
"score_threshold": {"description": "A minimum confidence score where inferred objects with a lower confidence will be filtered out.\n",
"type": "number",
"format": "float",
"minimum": 0,
"maximum": 1,
"default": 0.3
},
"iou_threshold": {"description": "An Intersection-over-Union ratio used to filter out overlapping bounding boxes of inferred objects.\n\nSee: https://learnopencv.com/non-maximum-suppression-theory-and-implementation-in-pytorch/\n",
"type": "number",
"format": "float",
"minimum": 0,
"maximum": 1,
"default": 0.3
}
},
"required": ["model"
]
},
"params_mapping": {"model": {"name": "model",
"hw": "hw"
}
}
},
{"name": "image-resize",
"params_schema": {"oneOf": [{"type": "object",
"properties": {"width": {"description": "The target width of the resized image.",
"type": "integer",
"exclusiveMinimum": 0
},
"height": {"description": "The target height of the resized image.",
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["width",
"height"
]
},
{"type": "object",
"properties": {"scale": {"description": "The scale by which to resize the image.",
"type": "number",
"exclusiveMinimum": 0
}
},
"required": ["scale"
]
}
]
},
"passthrough": true
}
],
"models": [{"name": "person-detection-nano",
"hw": "cpu",
"args": {"infer": {"model": "person-detection-nano",
"hw": "cpu"
}
}
},
{"name": "detr",
"hw": "gpu",
"args": {"infer": {"model": "detr",
"hw": "gpu"
}
}
}
],
"devices": [{"type": "cpu",
"current_models": 1
},
{"type": "gpu",
"current_models": 2,
"max_models": 10
}
]
}

Fetch Pipeline Elements

Retrieve all available pipeline elements.

Responses

Response samples

200

Content type

application/json

{"elements": [{"name": "string",
"version": "string",
"title": "string",
"description": "string",
"passthrough": true,
"params_schema": true,
"params_mapping": {"resource-type1": {"resource-property-name1": "string",
"resource-property-name2": "string"
},
"resource-type2": {"resource-property-name1": "string",
"resource-property-name2": "string"
}
},
"config_schema": true,
"input_schema": true,
"output_schema": true
}
]
}

Fetch Models

Retrieve all models that are available to be used for inferencing.

By default, the list of models are pre-filtered using the hardware devices that are available at runtime. Only models that have an available hardware device are included in the returned list. This pre-filtering can be disabled by setting the filter query parameter to none.

query Parameters

filter

Array of strings

Default: "devices"

Items Enum: "devices" "none"

Specify by which method(s) to filter the models.

Responses

Response samples

200

Content type

application/json

{"models": [{"name": "string",
"hw": "cpu",
"args": {"element-name1": { },
"element-name2": { }
}
}
]
}

Fetch Hardware Devices

Retrieve supported hardware devices and their availability for deploying models.

Responses

Response samples

200

Content type

application/json

{"devices": [{"type": "cpu",
"current_models": 0,
"max_models": null
}
]
}

Configuration

Nimble is controlled by a Configuration. A Configuration is a collection of Sources, Sinks and Pipeline Elements arranged to execute the desired analytic behaviour.

Fetch the Configuration

Retrieve the Configuration from Nimble.

Responses

Response samples

200

Content type

application/json

{"sources": [{"id": 0,
"type": "file",
"address": "input.mp4",
"rate": 30
},
{"id": 1,
"type": "video",
"address": "rtsp://localhost:554/axis-media/media.amp",
"rate": 25
}
],
"sinks": [{"id": 0,
"type": "video",
"address": "output.mp4",
"filter": [1
]
},
{"id": 1,
"type": "zmq",
"address": "tcp://*:22952",
"filter": [ ]
}
],
"pipelines": [{"id": 0,
"elements": [{"name": "infer",
"args": {"model": "person-detection-0200",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "social-distancing",
"args": {"threshold": 0.2
}
}
],
"usecase": "physical-distancing",
"sources": [0,
1
],
"sinks": [0,
1
]
}
]
}

Deploy a Configuration Deprecated

Deploy a Configuration to Nimble.

Request Body schema: application/json
required

The new Configuration in list-based format, see config.yaml.

Array

required	Array of Video (object) or File (object) or Nimble (object) or ZeroMQ (object) or Infinite (object) (source_fingerprint) non-empty
	Array of objects
	Array of objects (Pipeline Element) non-empty
usecase	string or null

Responses

Request samples

Payload

Content type

application/json

[{"sources": [{"type": "file",
"address": "videos/sd_london_station_sd.mp4",
"rate": 25
}
],
"sinks": [{"type": "zmq",
"address": "tcp://*:22952",
"filter": [ ]
}
],
"elements": [{"name": "infer",
"args": {"model": "person-detection-nano",
"hw": "cpu",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "detect-zone-intersection",
"args": {"region": "bottom"
},
"config": {"zones": [{"name": "zone1",
"coords": [{"x": 0.6042,
"y": 0.0157
},
{"x": 0.5406,
"y": 0.2259
},
{"x": 0.7531,
"y": 0.2204
},
{"x": 0.7906,
"y": 0.013
}
]
}
]
}
}
],
"usecase": "intrusion-detection"
}
]

Response samples

400

Content type

application/json

{"code": "syntax",
"reason": "string"
}

Reset the Configuration

Reset the entire Configuration to an empty state.

Responses

Source

A Source brings in data and pushes it to one or more Pipelines. Sources are generally URLs to video streams or other media but can also be other Nimble instances or files for offline processing.

Fetch all Sources

Retrieve all Sources in the Configuration.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"type": "file",
"address": "input.mp4",
"rate": 30
},
{"id": 1,
"type": "video",
"address": "rtsp://localhost:554/axis-media/media.amp",
"rate": 25
}
]

Create a Source

Create a Source in the Configuration.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/json
required

The new Source.

One of

type required	string Value: "video"
required	Short-form (string) or Long-form (object) The URL to a camera or other video streaming device.
rate	number <float> > 0 The playback rate of the video stream. The ingestion rate is always real-time, but if the playback rate is slower than the ingestion rate then frames will be dropped. Optional, if omitted playback will occur at the video-defined speed.
decoder	string Default: "gst_h264" Enum: "gst" "gst_h264" "ffmpeg" The name of the desired video decoder library.

Responses

Request samples

Payload

Content type

application/json

{"type": "video",
"address": "rtsp://localhost:554/axis-media/media.amp",
"rate": 25
}

Response samples

200
201
400

Content type

application/json

{"id": 0,
"type": "video",
"address": "rtsp://localhost:554/axis-media/media.amp",
"rate": 25
}

Fetch a Sources information

Retrieve all of the information about a Source (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (id) >= 0

The ID of the Source.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"type": "video",
"address": "rtsp://localhost:554/axis-media/media.amp",
"rate": 25
}

Update a Source

Update a Source (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (id) >= 0

The ID of the Source.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/json
required

The Source's information.

One of

type required	string Value: "video"
required	Short-form (string) or Long-form (object) The URL to a camera or other video streaming device.
rate	number <float> > 0 The playback rate of the video stream. The ingestion rate is always real-time, but if the playback rate is slower than the ingestion rate then frames will be dropped. Optional, if omitted playback will occur at the video-defined speed.
decoder	string Default: "gst_h264" Enum: "gst" "gst_h264" "ffmpeg" The name of the desired video decoder library.

Responses

Request samples

Payload

Content type

application/json

{"type": "file",
"address": "input.mp4",
"rate": 30
}

Response samples

200
400

Content type

application/json

{"id": 0,
"type": "file",
"address": "input.mp4",
"rate": 30
}

Modify a Source

Modify a Source (by ID) in the Configuration.
JSON merge patch (RFC7386) is used to apply the modifications to the Source's information.

path Parameters

id

required

integer <int32> (id) >= 0

The ID of the Source.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/merge-patch+json
required

The Source's information

non-empty

One of

non-empty

type required	string Value: "video"
required	Short-form (string) or Long-form (object) The URL to a camera or other video streaming device.
rate	number <float> > 0 The playback rate of the video stream. The ingestion rate is always real-time, but if the playback rate is slower than the ingestion rate then frames will be dropped. Optional, if omitted playback will occur at the video-defined speed.
decoder	string Default: "gst_h264" Enum: "gst" "gst_h264" "ffmpeg" The name of the desired video decoder library.

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"type": "file",
"address": "input.mp4"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"type": "file",
"address": "input.mp4",
"rate": 25
}

Delete a Source

Delete a Source (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (id) >= 0

The ID of the Source.

query Parameters

force

boolean

Default: false

Whether to force deletion of the Source even if it is being referenced by a Pipeline. If true, the Source will be automatically removed from any Pipelines that reference it.

Responses

Response samples

409

Content type

application/json

{"code": "reference",
"reason": "string",
"value": {"pipelines": [0,
1
]
}
}

Fetch a Sources statistics

Retrieve all the runtime statistics for a Source (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (id) >= 0

The ID of the Source.

Responses

Response samples

200

Content type

application/json

Example

Source starting

{"status": "starting",
"fps": 0,
"latency": 0
}

Sink

A Sink takes data from a Pipeline and pushes it out. Apart from the WebSocket API, which is always active and can be found here, other Sinks such has ZMQ sockets or file can be created.

Fetch all Sinks

Retrieve all Sinks in the Configuration.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"type": "video",
"address": "output.mp4",
"filter": [1
]
},
{"id": 1,
"type": "zmq",
"address": "tcp://*:22952",
"filter": [ ]
}
]

Create a Sink

Create a Sink in the Configuration.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/json
required

The Sink.

type required	string (type) Enum: "file" "embedding" "zmq" "inf"
address required	string (address)
filter	Array of integers <int32> (filter) unique [ items <int32 > >= 0 ] A list of sources to include. An empty list indicates no filtering is enabled.

Responses

Request samples

Payload

Content type

application/json

{"type": "video",
"address": "output.mp4"
}

Response samples

200
201
400

Content type

application/json

{"id": 0,
"type": "video",
"address": "output.mp4",
"filter": [ ]
}

Fetch a Sinks information

Retrieve all of the information about a Sink (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (sink_id) >= 0

The ID of the Sink.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"type": "zmq",
"address": "tcp://*:22952",
"filter": [ ]
}

Update a Sink

Update a Sink (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (sink_id) >= 0

The ID of the Sink.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/json
required

The Sink's information.

type required	string (type) Enum: "file" "embedding" "zmq" "inf"
address required	string (address)
filter	Array of integers <int32> (filter) unique [ items <int32 > >= 0 ] A list of sources to include. An empty list indicates no filtering is enabled.

Responses

Request samples

Payload

Content type

application/json

{"type": "video",
"address": "output.mp4",
"filter": [1
]
}

Response samples

200
400

Content type

application/json

{"id": 0,
"type": "video",
"address": "output.mp4",
"filter": [1
]
}

Modify a Sink

Modify a Sink (by ID) in the Configuration.
JSON merge patch (RFC7386) is used to apply the modifications to the Sink's information.

path Parameters

id

required

integer <int32> (sink_id) >= 0

The ID of the Sink.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/merge-patch+json
required

The Sink's information.

non-empty

type	string (type) Enum: "file" "embedding" "zmq" "inf"
address	string (address)
filter	Array of integers <int32> (filter) unique [ items <int32 > >= 0 ] A list of sources to include. An empty list indicates no filtering is enabled.

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"type": "video",
"address": "output.mp4"
}

Response samples

200
400

Content type

application/json

{"id": 0,
"type": "video",
"address": "output.mp4",
"filter": [ ]
}

Delete a Sink

Delete a Sink (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (sink_id) >= 0

The ID of the Sink.

query Parameters

force

boolean

Default: false

Whether to force deletion of the Sink even if it is being referenced by a Pipeline. If true, the Sink will be automatically removed from any Pipelines that reference it.

Responses

Response samples

409

Content type

application/json

{"code": "reference",
"reason": "string",
"value": {"pipelines": [0,
1
]
}
}

Fetch a Sinks statistics

Retrieve all the runtime statistics for a Sink (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (sink_id) >= 0

The ID of the Sink.

Responses

Response samples

200

Content type

application/json

Example

Sink starting

{"status": "starting",
"fps": 0,
"latency": 0
}

Pipeline

A Pipeline is a list elements or operations that perform the desired analytics task. Pipelines can be constructed for a number of different elements that execute Deep Learning, Machine Learning, OpenCV-based functions or custom algorithms.

Fetch all Pipelines

Retrieve all Pipelines in the Configuration.

Responses

Response samples

200

Content type

application/json

[{"id": 0,
"elements": [{"name": "infer",
"args": {"model": "person-detection-0200",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "social-distancing",
"args": {"threshold": 0.2
}
}
],
"usecase": "physical-distancing",
"sources": [0,
1
],
"sinks": [0,
1
]
}
]

Fetch elements and models Deprecated

Retrieve all pipeline elements and models that are available from Nimble.

query Parameters

filter

Array of strings

Items Enum: "elements" "models"

Specify the top-level resource types to retrieve.

Responses

Response samples

200

Content type

application/json

{"elements": [{"name": "infer",
"title": "Infer",
"params_schema": {"type": "object",
"properties": {"model": {"description": "The name of the model to use for inference.",
"type": "string"
},
"hw": {"description": "The type of hardware device to use to run the model.",
"type": "string",
"enum": ["auto",
"cpu",
"igpu",
"gpu"
],
"default": "auto"
},
"score_threshold": {"description": "A minimum confidence score where inferred objects with a lower confidence will be filtered out.\n",
"type": "number",
"format": "float",
"minimum": 0,
"maximum": 1,
"default": 0.3
},
"iou_threshold": {"description": "An Intersection-over-Union ratio used to filter out overlapping bounding boxes of inferred objects.\n\nSee: https://learnopencv.com/non-maximum-suppression-theory-and-implementation-in-pytorch/\n",
"type": "number",
"format": "float",
"minimum": 0,
"maximum": 1,
"default": 0.3
}
},
"required": ["model"
]
},
"params_mapping": {"model": {"name": "model",
"hw": "hw"
}
}
},
{"name": "image-resize",
"params_schema": {"oneOf": [{"type": "object",
"properties": {"width": {"description": "The target width of the resized image.",
"type": "integer",
"exclusiveMinimum": 0
},
"height": {"description": "The target height of the resized image.",
"type": "integer",
"exclusiveMinimum": 0
}
},
"required": ["width",
"height"
]
},
{"type": "object",
"properties": {"scale": {"description": "The scale by which to resize the image.",
"type": "number",
"exclusiveMinimum": 0
}
},
"required": ["scale"
]
}
]
},
"passthrough": true
}
],
"models": [{"name": "person-detection-nano",
"hw": "cpu",
"args": {"infer": {"model": "person-detection-nano",
"hw": "cpu"
}
}
},
{"name": "detr",
"hw": "gpu",
"args": {"infer": {"model": "detr",
"hw": "gpu"
}
}
}
]
}

Create a Pipeline

Create a Pipeline in the Configuration.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/json
required

The Pipeline.

required	Array of objects (elements) non-empty Sequence of processing elements
usecase	string (usecase) The high-level description of the analytics performed by the pipeline.
sources	Array of integers <int32> (sources) [ items <int32 > >= 0 ] IDs of input sources to the pipeline
sinks	Array of integers <int32> (sinks) [ items <int32 > >= 0 ] IDs of output sinks from the pipeline

Responses

Request samples

Payload

Content type

application/json

{"elements": [{"name": "infer",
"args": {"model": "person-detection-nano",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "object-tracking-OH",
"args": {"max_age": 3,
"min_hits": 3,
"history": 50,
"region": "bottom",
"ratio": 0.2,
"moving_average": 3
}
},
{"name": "line-crossing",
"args": {"directions": [-1
],
"history": 5,
"region": "bottom",
"ratio": 0.2
},
"config": {"0": {"lines": [{"name": "Entrance",
"coords": [{"x": 0.486,
"y": 0.473
},
{"x": 0.358,
"y": 0.786
}
]
}
]
},
"1": {"lines": [{"name": "Exit",
"coords": [{"x": 0.287,
"y": 0.569
},
{"x": 0.909,
"y": 0.14
}
]
}
]
},
"2,3": {"lines": [{"name": "Tickets",
"coords": [{"x": 0.451,
"y": 0.471
},
{"x": 0.755,
"y": 0.467
}
]
}
]
}
}
}
],
"usecase": "line-crossing",
"sources": [0,
1,
2,
3
]
}

Response samples

200
201
400

Content type

application/json

{"id": 0,
"elements": [{"name": "infer",
"args": {"model": "person-detection-nano",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "object-tracking-OH",
"args": {"max_age": 3,
"min_hits": 3,
"history": 50,
"region": "bottom",
"ratio": 0.2,
"moving_average": 3
}
},
{"name": "line-crossing",
"args": {"directions": [-1
],
"history": 5,
"region": "bottom",
"ratio": 0.2
},
"config": {"0": {"lines": [{"name": "Entrance",
"coords": [{"x": 0.486,
"y": 0.473
},
{"x": 0.358,
"y": 0.786
}
]
}
]
},
"1": {"lines": [{"name": "Exit",
"coords": [{"x": 0.287,
"y": 0.569
},
{"x": 0.909,
"y": 0.14
}
]
}
]
},
"2,3": {"lines": [{"name": "Tickets",
"coords": [{"x": 0.451,
"y": 0.471
},
{"x": 0.755,
"y": 0.467
}
]
}
]
}
}
}
],
"usecase": "line-crossing",
"sources": [0,
1,
2,
3
],
"sinks": [ ]
}

Fetch a Pipelines information

Get information about a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

Responses

Response samples

200

Content type

application/json

{"id": 0,
"elements": [{"name": "infer",
"args": {"model": "person-detection-0200",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "social-distancing",
"args": {"threshold": 0.2
}
}
],
"usecase": "physical-distancing",
"sources": [0,
1
],
"sinks": [0,
1
]
}

Update a Pipeline

Update a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/json
required

The Pipeline information.

required	Array of objects (elements) non-empty Sequence of processing elements
usecase	string (usecase) The high-level description of the analytics performed by the pipeline.
sources	Array of integers <int32> (sources) [ items <int32 > >= 0 ] IDs of input sources to the pipeline
sinks	Array of integers <int32> (sinks) [ items <int32 > >= 0 ] IDs of output sinks from the pipeline

Responses

Request samples

Payload

Content type

application/json

{"elements": [{"name": "infer",
"args": {"model": "person-detection-nano",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "object-tracking-OH",
"args": {"max_age": 3,
"min_hits": 3,
"history": 50,
"region": "bottom",
"ratio": 0.2,
"moving_average": 3
}
},
{"name": "line-crossing",
"args": {"directions": [-1
],
"history": 5,
"region": "bottom",
"ratio": 0.2
},
"config": {"0": {"lines": [{"name": "Entrance",
"coords": [{"x": 0.486,
"y": 0.473
},
{"x": 0.358,
"y": 0.786
}
]
}
]
},
"1": {"lines": [{"name": "Exit",
"coords": [{"x": 0.287,
"y": 0.569
},
{"x": 0.909,
"y": 0.14
}
]
}
]
},
"2,3": {"lines": [{"name": "Tickets",
"coords": [{"x": 0.451,
"y": 0.471
},
{"x": 0.755,
"y": 0.467
}
]
}
]
}
}
}
],
"usecase": "line-crossing",
"sources": [0,
1,
2,
3
]
}

Response samples

200
400

Content type

application/json

{"id": 0,
"elements": [{"name": "infer",
"args": {"model": "person-detection-nano",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "object-tracking-OH",
"args": {"max_age": 3,
"min_hits": 3,
"history": 50,
"region": "bottom",
"ratio": 0.2,
"moving_average": 3
}
},
{"name": "line-crossing",
"args": {"directions": [-1
],
"history": 5,
"region": "bottom",
"ratio": 0.2
},
"config": {"0": {"lines": [{"name": "Entrance",
"coords": [{"x": 0.486,
"y": 0.473
},
{"x": 0.358,
"y": 0.786
}
]
}
]
},
"1": {"lines": [{"name": "Exit",
"coords": [{"x": 0.287,
"y": 0.569
},
{"x": 0.909,
"y": 0.14
}
]
}
]
},
"2,3": {"lines": [{"name": "Tickets",
"coords": [{"x": 0.451,
"y": 0.471
},
{"x": 0.755,
"y": 0.467
}
]
}
]
}
}
}
],
"usecase": "line-crossing",
"sources": [0,
1,
2,
3
],
"sinks": [ ]
}

Modify a Pipeline

Modify a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

header Parameters

object

Examples:

return=minimal - Request minimal response (ID only)
return=representation - Request full representational response

The preferred response (minimal or full)

Request Body schema: application/merge-patch+json
required

The Pipeline information.

non-empty

	Array of objects (elements) non-empty Sequence of processing elements
usecase	string (usecase) The high-level description of the analytics performed by the pipeline.
sources	Array of integers <int32> (sources) [ items <int32 > >= 0 ] IDs of input sources to the pipeline
sinks	Array of integers <int32> (sinks) [ items <int32 > >= 0 ] IDs of output sinks from the pipeline

Responses

Request samples

Payload

Content type

application/merge-patch+json

{"elements": [{"name": "infer",
"args": {"model": "person-detection-0200",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "object-tracking",
"args": {"max_age": 5,
"history": 50,
"sampling_frequency": 20
}
}
],
"sinks": [2,
3
]
}

Response samples

200
400

Content type

application/json

{"id": 0,
"elements": [{"name": "infer",
"args": {"model": "person-detection-0200",
"score_threshold": 0.3,
"iou_threshold": 0.3
}
},
{"name": "object-tracking",
"args": {"max_age": 5,
"history": 50,
"sampling_frequency": 20
}
}
],
"usecase": "tracing",
"sources": [0,
1
],
"sinks": [2,
3
]
}

Delete a pipeline

Delete a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

query Parameters

force

boolean

Default: false

Whether to force deletion of the Pipeline even if it is connected to a Source or Sink. If true, the Pipeline will be automatically disconnected from any Sources or Sinks.

Responses

Response samples

409

Content type

application/json

{"code": "reference",
"reason": "string",
"value": {"sources": [1,
3
],
"sinks": [0,
1
]
}
}

Fetch a Pipelines statistics

Retrieve all the runtime statistics for a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

Responses

Response samples

200

Content type

application/json

Example

Pipeline starting

{"status": "starting",
"fps": 0,
"latency": 0
}

Add Sources to Pipeline

Connect Sources as input to a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

Request Body schema: application/json
required

The Sources to connect.

Array (non-empty)

integer <int32> (id) >= 0

Source ID

Responses

Request samples

Payload

Content type

application/json

[0,
1,
2
]

Response samples

400

Content type

application/json

{"code": "id",
"reason": "string",
"value": {"id": "string",
"sources": [0
]
}
}

Remove Source from Pipeline

Disconnect Sources from a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

Request Body schema: application/json
required

The Sources to disconnect.

Array (non-empty)

integer <int32> (id) >= 0

Source ID

Responses

Request samples

Payload

Content type

application/json

[1,
2
]

Response samples

400

Content type

application/json

{"code": "id",
"reason": "string",
"value": {"id": "string",
"sources": [0
]
}
}

Add Sinks to a Pipeline

Connect Sinks as output to a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

Request Body schema: application/json
required

The Sinks to connect.

Array (non-empty)

integer <int32> (sink_id) >= 0

Sink ID

Responses

Request samples

Payload

Content type

application/json

[1,
2
]

Response samples

400

Content type

application/json

{"code": "id",
"reason": "string",
"value": {"id": "string",
"sinks": [0
]
}
}

Remove Sinks from Pipeline

Disconnect Sinks from a Pipeline (by ID) in the Configuration.

path Parameters

id

required

integer <int32> (pipeline_id) >= 0

The ID of the Pipeline.

Request Body schema: application/json
required

The Sinks to disconnect.

Array (non-empty)

integer <int32> (sink_id) >= 0

Sink ID

Responses

Request samples

Payload

Content type

application/json

[2
]

Response samples

400

Content type

application/json

{"code": "id",
"reason": "string",
"value": {"id": "string",
"sinks": [0
]
}
}

Exports

Exports allow you to inspect Channel properties such as its current Configuration, processing rate (FPS), and latency.

Fetch Channels and Streams

Retrieve the Channels and Streams from the Configuration.

query Parameters

filter

Array of strings

Items Enum: "streams" "channels"

Specify the top-level resource types to retrieve.

Responses

Response samples

200

Content type

application/json

{"streams": [{"id": 0,
"sources": [0,
3
]
},
{"id": 1,
"sources": [1
]
}
],
"channels": [{"id": 0,
"source": 0,
"pipeline": 0,
"stream": 0
},
{"id": 1,
"source": 3,
"pipeline": 1,
"stream": 0
},
{"id": 2,
"source": 2,
"pipeline": 2,
"stream": null
},
{"id": 3,
"source": 1,
"pipeline": 3,
"stream": {"id": 0,
"hostname": "nimble-edge",
"port": 6345
}
}
]
}

Fetch a Channel's information

Retrieve all of the information about a Channel (by ID).

path Parameters

id

required

integer <int32> (channel_id) >= 0

The ID of the Channel.

Responses

Response samples

200

Content type

application/json

Example

Channel with No Stream

{"id": 0,
"source": 0,
"pipeline": 0,
"stream": null
}

Fetch a Channel's static metadata

Retrieve the Channel's static metadata.

path Parameters

id

required

integer <int32> (channel_id) >= 0

The ID of the Channel.

query Parameters

format

string (formatterWithPass)

Default: "pass"

Enum: "aws" "megh" "pass"

The formatter to use to output the static metadata.

Responses

Response samples

200

Content type

application/json

{ }

Fetch a Channel's statistics

Retrieve all the runtime statistics for a Channel (by ID).

path Parameters

id

required

integer <int32> (channel_id) >= 0

The ID of the Channel.

Responses

Response samples

200

Content type

application/json

Example

Channel starting

{"status": "starting",
"fps": 0,
"latency": 0
}

Fetch a Channel's FPS

Retrieve the estimated processing frame rate of the Channel (measured in frames per second).

path Parameters

id

required

integer <int32> (channel_id) >= 0

The ID of the Channel.

Responses

Response samples

200

Content type

application/json

{"fps": 24.98
}

Fetch a Channel's latency

Retrieve the estimated end-to-end processing latency of the Channel (measured in milliseconds).

path Parameters

id

required

integer <int32> (channel_id) >= 0

The ID of the Channel.

Responses

Response samples

200

Content type

application/json

{"latency": 134.1
}

Fetch all Channel properties

Retrieve the properties of all Channels.

query Parameters

ids	Array of integers <int32> (channel_id) [ items <int32 > >= 0 ] The Channel IDs to query.
props	Array of strings Items Enum: "source" "pipeline" "stream" "usecase" "static" "fps" "latency" The requested properties for each Channel.
format	string (formatterWithPass) Default: "pass" Enum: "aws" "megh" "pass" The formatter to use to output the static metadata.

Responses

Response samples

200

Content type

application/json

{"0": {"source": 0,
"pipeline": 0,
"stream": 0,
"usecase": "physical-distancing",
"static": { },
"fps": 24.52,
"latency": 89.41
},
"1": {"source": 0,
"pipeline": 1,
"stream": 0,
"usecase": "line-crossing",
"static": {"lines": {"line1": {"Name": "Bathroom",
"Coords": [[0.13,
0.56
],
[0.23,
0.98
]
]
},
"line2": {"Name": "Exit",
"Coords": [[0.87,
0.34
],
[0.19,
0.38
]
]
}
}
},
"fps": 14.9,
"latency": 56.7
}
}

Statistics

Statistics allows you to inspect Nimble's system-level details such as current CPU and Memory load.

Fetch all statistics

Retrieve all dynamic statistics of Nimble.

Responses

Response samples

200

Content type

application/json

{"uptime": 3987.291,
"cpu": 7.92,
"memory": {"virtual": 2684354560,
"physical": 838860800,
"total": 4294967296,
"available": 1073741824
},
"network": {"send": 524288,
"receive": 524288,
"congestion": false
},
"activated": true
}

Fetch uptime

Retrieve the time since Nimble started (in seconds)

Responses

Response samples

200

Content type

application/json

{"uptime": 3987.291
}

Fetch CPU usage

Retrieve estimated CPU usage of Nimble over the last minute (measured in virtual cores).

Responses

Response samples

200

Content type

application/json

{"cpu": 7.92
}

Fetch memory usage

Retrieve estimated memory usage of Nimble (measured in bytes).

Responses

Response samples

200

Content type

application/json

{"memory": {"virtual": 2684354560,
"physical": 838860800,
"total": 4294967296,
"available": 1073741824
}
}

Fetch network usage

Retrieve estimated network usage of Nimble (measured in bytes/sec).

Responses

Response samples

200

Content type

application/json

{"network": {"send": 524288,
"receive": 524288,
"congestion": false
}
}

Fetch activation status

Retrieve license activation status of Nimble.

Responses

Response samples

200

Content type

application/json

{"activated": true
}

About

General information about Nimble.

Fetch all information

Retrieve all general information about Nimble.

Responses

Response samples

200

Content type

application/json

{"version": "0.11",
"hostname": "nimble-k8sj1ld",
"hash": "c627841eadcb31f12588051183ef996145acfda4fb89d3baaf04242213ce44f3"
}

Fetch version

Fetch the version of Nimble.

Responses

Response samples

200

Content type

application/json

{"version": "0.11"
}

Fetch hostname

Fetch the hostname of the machine (or container) that Nimble is running on.

Responses

Response samples

200

Content type

application/json

{"hostname": "nimble-k8sj1ld"
}

Fetch hash

Fetch the randomly-generated hash to uniquely identify the instance of Nimble.

Responses

Response samples

200

Content type

application/json

{"hash": "c627841eadcb31f12588051183ef996145acfda4fb89d3baaf04242213ce44f3"
}

Nimble REST API (v1)

What is a REST API?

The Key Elements of Nimble

Activation

Activate

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Fetch activation status

Responses

Response samples

Catalog

Fetch Catalog

query Parameters

Responses

Response samples

Fetch Pipeline Elements

Responses

Response samples

Fetch Models

query Parameters

Responses

Response samples

Fetch Hardware Devices

Responses

Response samples

Configuration

Fetch the Configuration

Responses

Response samples

Deploy a Configuration Deprecated

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Reset the Configuration

Responses

Source

Fetch all Sources

Responses

Response samples

Create a Source

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch a Sources information

path Parameters

Responses

Response samples

Update a Source

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Modify a Source

path Parameters

header Parameters

Request Body schema: application/merge-patch+jsonrequired

Responses

Request samples

Response samples

Delete a Source

path Parameters

query Parameters

Responses

Response samples

Fetch a Sources statistics

path Parameters

Responses

Response samples

Sink

Fetch all Sinks

Responses

Response samples

Create a Sink

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required