interfaces.md

GET /models

Return supported models

Responses

200 - Success

application/json

Example

[
  {
    "name": "name",
    "description": "description",
    "type": "IntelDLDT",
    "version": 0
  }
]

GET /pipelines

Return supported pipelines

Responses

200 - Success

application/json

Example (generated)

[
  {
    "description": "description",
    "type": "GStreamer",
    "parameters": {
      "key": {
        "default": ""
      }
    }
  }
]

GET /pipelines/{name}/{version}

Return pipeline description.

Path parameters

▷ name

Name	Type	In	Accepted values
name (required)	string	path	Any

▷ version

Name	Type	In	Accepted values
version (required)	string	path	Any

Responses

200 - Success

application/json

Example

{
  "description": "description",
  "type": "GStreamer",
  "parameters": {
    "key": {
      "default": ""
    }
  }
}

POST /pipelines/{name}/{version}

Start new pipeline instance. Four sections are supported by default: source, destination, parameters, and tags. These sections have special handling based on the default schema and/or the schema defined in the pipeline.json file for the requested pipeline.

Path parameters

▷ name

Name	Type	In	Accepted values
name (required)	string	path	Any

▷ version

Name	Type	In	Accepted values
version (required)	integer	path	Any

Request body

application/json

Example

{
  "source": {
    "type": "uri",
    "uri": "file:///root/video-examples/example.mp4"
  },
  "destination":{},
  "parameters": {},
  "tags": {}
}

Responses

200 - Success

DELETE /pipelines/{name}/{version}/{instance_id}

Stop pipeline instance.

Path parameters

▷ name

Name	Type	In	Accepted values
name (required)	string	path	Any

▷ version

Name	Type	In	Accepted values
version (required)	integer	path	Any

▷ instance_id

Name	Type	In	Accepted values
instance_id (required)	integer	path	Any

Responses

200 - Success

GET /pipelines/{name}/{version}/{instance_id}

Return pipeline instance summary.

Path parameters

▷ name

Name	Type	In	Accepted values
name (required)	string	path	Any

▷ version

Name	Type	In	Accepted values
version (required)	integer	path	Any

▷ instance_id

Name	Type	In	Accepted values
instance_id (required)	integer	path	Any

Responses

200 - Success

application/json

Example

{
  "request": {
    "destination": {},
    "source": {},
    "parameters": {},
    "tags": {}
  },
  "id": 0,
  "type": "type"
}

GET /pipelines/{name}/{version}/{instance_id}/status

Return pipeline instance status.

Path parameters

▷ name

Name	Type	In	Accepted values
name (required)	string	path	Any

▷ version

Name	Type	In	Accepted values
version (required)	integer	path	Any

▷ instance_id

Name	Type	In	Accepted values
instance_id (required)	integer	path	Any

Responses

200 - Success

application/json

Example

{
  "start_time": 1,
  "elapsed_time": 5,
  "id": 0,
  "state": "RUNNING",
  "avg_fps": 6.027456183070403
}