Extra Brain

API Model Manager

Interactive documentation of BCPNN endpoints for managing invocations, files and executions on ZCU104

API
Base URL
All endpoints are based on this URL

Available Endpoints

GET
List Invocations

Gets the list of all BCPNN invocations

URL

Informational only — use the Postman collection to test these endpoints.

POST
Create New Invocation

Creates a new invocation with name and description

URL
Example body:
                        {"name": "test_01", "description": "Test description"}
                      

Informational only — use the Postman collection to test these endpoints.

GET
Get Invocation Details

Gets the complete details of a specific invocation

URL

Informational only — use the Postman collection to test these endpoints.

POST
Upload File to Invocation

Uploads a file to the invocation (parameter, bitstream, weights, input_video)

URL
Content-Type: multipart/form-data

Informational only — use the Postman collection to test these endpoints.

POST
Upload Files to ZCU104

Uploads the invocation files to ZCU104 via SCP

URL

Informational only — use the Postman collection to test these endpoints.

POST
Execute Invocation on ZCU104

Executes the invocation on ZCU104 (uploads, executes and downloads video)

URL

Informational only — use the Postman collection to test these endpoints.

GET
Get Output Video

Serves the output video of the invocation (MP4 or AVI)

URL

Informational only — use the Postman collection to test these endpoints.

GET
List All Videos

Lists all available videos from invocations and results/ folder

URL

Informational only — use the Postman collection to test these endpoints.

DELETE
Delete Invocation

Deletes an invocation and all its associated files

URL

Informational only — use the Postman collection to test these endpoints.

POST
Query Available PACs

Query all available PACs on ZCU104

URL
Content-Type: application/json

Informational only — use the Postman collection to test these endpoints.

POST
Activate PAC on ZCU104

Activates a specific PAC on ZCU104 and reboots

URL
Content-Type: application/json

Informational only — use the Postman collection to test these endpoints.

POST
Upload New PAC to ZCU104

Uploads and installs a new PAC on ZCU104

URL
Content-Type: multipart/form-data

Informational only — use the Postman collection to test these endpoints.

GET
Download Invocation Files (ZIP)

Downloads all invocation files as a ZIP archive

URL

Informational only — use the Postman collection to test these endpoints.

cURL Examples
                  curl -X GET http://model-manager.extra-brain.unparallel.pt/api/invocations/ \ -H "Content-Type: application/json"
                
                  curl -X POST http://model-manager.extra-brain.unparallel.pt/api/invocations/create/ \ -H "Content-Type: application/json" \ -d '{ "name": "my_test", "description": "Test description" }'
                
                  curl -X POST http://model-manager.extra-brain.unparallel.pt/api/invocations/1/execute/ \ -H "Content-Type: application/json"
                
Import in Postman

For more comprehensive testing, import the Postman collection:

Download Postman Collection

1. Open Postman
2. File → Import
3. Select the downloaded file
4. Ready to use!