Download OpenAPI specification:Download
The Nx Compute API handles managing of the models.
With the calls in this API to browse and manage models in the Scailable Cloud. You can list, search and add models and you can create, list and edit the catalogues for the models.
The private endpoints in the Admin and IPC sections are used in the internal admin tools. These are not visible in the public documentation.
Browse models by sending a GET request to /functions
and use query parameters to search specific models.
Get all available catalogues by sending a GET request to /catalogues
and then get the functions in a Catalogue with a GET request to /catalogue/{uuid}
.
Use a POST request to /function
to add model information with an attached onnx file.
The Compute API is part of the Scailable Cloud and handles the management of models (compute functions) for the Cloud Admin interface.
Delete an empty catalogue.
Time-out set to 15s. Requires an authenticated user.
uuid required | any Use catalogue uuid |
{- "AuthorizationInvalid": true,
- "BackendMessage": "string",
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Return a single catalogue.
Time-out set to 1s. Requires an authenticated user.
uuid required | any Use catalogue uuid |
{- "Name": "string",
- "NoOfFunctions": 0,
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Edit a model catalogue.
Time-out set to 5s. Requires an authenticated user.
uuid required | any Use catalogue uuid |
Name required | string |
{- "Name": "string"
}
{- "AuthorizationInvalid": true,
- "BackendMessage": "string",
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Return all catalogues accessible.
Time-out set to 5s. Requires an authenticated user.
Organisation | string <uuid> filter by organisation |
[- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
]
Add a new catalogue.
Time-out set to 5s. Requires an authenticated user.
Name required | string |
{- "Name": "string"
}
{- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Return statistics for all functions.
Time-out set to 5s. Requires an authenticated user.
{- "FirstInsertedAt": "2019-08-24T14:15:22Z",
- "FirstUpdatedAt": "2019-08-24T14:15:22Z",
- "LastInsertedAt": "2019-08-24T14:15:22Z",
- "LastUpdatedAt": "2019-08-24T14:15:22Z",
- "NumberOfEvents": 0,
- "NumberOfEventsLast30": 0,
- "Total": 0
}
Delete a single function.
Time-out set to 15s. Requires an authenticated user.
uuid required | any Use function uuid |
{- "AuthorizationInvalid": true,
- "BackendMessage": "string",
- "Email": "string",
- "Field": {
- "Message": "string",
- "Name": "string"
}, - "Message": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
Return a function by UUID. If downloads are unavailable, downloads will be null.
Time-out set to 1s. Requires an authenticated user.
uuid required | any Use function uuid |
{- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "CDNURI": "string",
- "HumanError": "string",
- "Log": [
- {
- "At": "2019-08-24T14:15:22Z",
- "Data": { },
- "ID": 0,
- "Message": "string",
- "Status": "string"
}
], - "NotifyUserUUID": "a433fc8d-7a6c-4ad1-bf63-be27b82f5959",
- "OriginalModified": "2019-08-24T14:15:22Z",
- "OriginalName": "string",
- "OriginalSize": 0,
- "RuntimeArchitectures": [
- "string"
], - "Size": 0,
- "Status": "string",
- "TechError": "string",
- "Toolchain": "string",
- "UploaderUserUUID": "7e351b22-41d5-4c47-8a33-7907d6a838d7"
}, - "DisableConversions": [
- "string"
], - "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
Update a single function.
Time-out set to 5s. Requires an authenticated user.
uuid required | any Use function uuid |
bundle | string <binary> |
object |
{- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "CDNURI": "string",
- "HumanError": "string",
- "Log": [
- {
- "At": "2019-08-24T14:15:22Z",
- "Data": { },
- "ID": 0,
- "Message": "string",
- "Status": "string"
}
], - "NotifyUserUUID": "a433fc8d-7a6c-4ad1-bf63-be27b82f5959",
- "OriginalModified": "2019-08-24T14:15:22Z",
- "OriginalName": "string",
- "OriginalSize": 0,
- "RuntimeArchitectures": [
- "string"
], - "Size": 0,
- "Status": "string",
- "TechError": "string",
- "Toolchain": "string",
- "UploaderUserUUID": "7e351b22-41d5-4c47-8a33-7907d6a838d7"
}, - "DisableConversions": [
- "string"
], - "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
Request a download URL for a single function.
Time-out set to 5s. Requires an authenticated user.
uuid required | any Use function uuid |
{- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
Update a single function through the linked settings.
Time-out set to 5m0s. Requires an authenticated user.
uuid required | any Use function uuid |
DisableConversions required | Array of strings |
EdgeImpulse required | boolean |
{- "DisableConversions": [
- "string"
], - "EdgeImpulse": true
}
{- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "CDNURI": "string",
- "HumanError": "string",
- "Log": [
- {
- "At": "2019-08-24T14:15:22Z",
- "Data": { },
- "ID": 0,
- "Message": "string",
- "Status": "string"
}
], - "NotifyUserUUID": "a433fc8d-7a6c-4ad1-bf63-be27b82f5959",
- "OriginalModified": "2019-08-24T14:15:22Z",
- "OriginalName": "string",
- "OriginalSize": 0,
- "RuntimeArchitectures": [
- "string"
], - "Size": 0,
- "Status": "string",
- "TechError": "string",
- "Toolchain": "string",
- "UploaderUserUUID": "7e351b22-41d5-4c47-8a33-7907d6a838d7"
}, - "DisableConversions": [
- "string"
], - "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
To get uncatalogued models, the "nil" UUID is used as Catalogue query parameter. To filter by width/height, use: 200- (upper range), -200 (lower range), 100-200 (complete range).
Time-out set to 5s. Requires an authenticated user.
Offset | integer Number of items to skip from beginning of list (base 0) |
Limit | integer Number of items to return |
OrderBy | string Enum: "Name" "UpdatedAt" "InsertedAt" Order the list by these fields. Add a '-' in front of the field to reverse sort and to sort on multiple fields separate them by a comma. |
q | string or null Filter by search text |
Status | string filter by status |
Catalogue | string <uuid> filter by catalogue |
LicensedCatalogue | Array of strings <uuid> filter by licensedcatalogue |
Functions | Array of strings <uuid> filter by functions |
SourceName | string filter by sourcename |
SourceUrl | string filter by sourceurl |
Width | string filter by width |
Height | string filter by height |
RuntimeArch | string filter by runtimearch |
OutputProperty | string filter by outputproperty |
InputProperty | string filter by inputproperty |
[- {
- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "RuntimeArchitectures": [
- "string"
], - "Size": 0
}, - "Documentation": "string",
- "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
]
Add a new function.
Time-out set to 5m0s. Requires an authenticated user.
Alias | string or null |
DisableConversions required | Array of strings |
Documentation | string or null |
InputDriver required | string |
InputDriverDetails required | object of type map |
Name required | string |
OutputDriver required | string |
OutputDriverDetails required | object of type map |
SourceName | string or null |
SourceUrl | string or null |
{- "Alias": "string",
- "DisableConversions": [
- "string"
], - "Documentation": "string",
- "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "SourceName": "string",
- "SourceUrl": "string"
}
{- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "CDNURI": "string",
- "HumanError": "string",
- "Log": [
- {
- "At": "2019-08-24T14:15:22Z",
- "Data": { },
- "ID": 0,
- "Message": "string",
- "Status": "string"
}
], - "NotifyUserUUID": "a433fc8d-7a6c-4ad1-bf63-be27b82f5959",
- "OriginalModified": "2019-08-24T14:15:22Z",
- "OriginalName": "string",
- "OriginalSize": 0,
- "RuntimeArchitectures": [
- "string"
], - "Size": 0,
- "Status": "string",
- "TechError": "string",
- "Toolchain": "string",
- "UploaderUserUUID": "7e351b22-41d5-4c47-8a33-7907d6a838d7"
}, - "DisableConversions": [
- "string"
], - "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
Return a list of functions (compatibility-only call).
Time-out set to 5s. Requires an authenticated user.
Offset | integer Number of items to skip from beginning of list (base 0) |
Limit | integer Number of items to return |
OrderBy | string Enum: "Name" "UpdatedAt" Order the list by these fields. Add a '-' in front of the field to reverse sort and to sort on multiple fields separate them by a comma. |
Status | string filter by status |
Catalogue | string <uuid> filter by catalogue |
[- {
- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "CDNURI": "string",
- "HumanError": "string",
- "Log": [
- {
- "At": "2019-08-24T14:15:22Z",
- "Data": { },
- "ID": 0,
- "Message": "string",
- "Status": "string"
}
], - "NotifyUserUUID": "a433fc8d-7a6c-4ad1-bf63-be27b82f5959",
- "OriginalModified": "2019-08-24T14:15:22Z",
- "OriginalName": "string",
- "OriginalSize": 0,
- "RuntimeArchitectures": [
- "string"
], - "Size": 0,
- "Status": "string",
- "TechError": "string",
- "Toolchain": "string",
- "UploaderUserUUID": "7e351b22-41d5-4c47-8a33-7907d6a838d7"
}, - "DisableConversions": [
- "string"
], - "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
]
Add a new function with a linked remote.
Time-out set to 5s. Requires an authenticated user.
DisableConversions required | Array of strings |
{- "DisableConversions": [
- "string"
]
}
{- "Alias": "string",
- "Catalogues": [
- {
- "Name": "string",
- "Organisation": {
- "Name": "string",
- "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30"
}
], - "Code": {
- "CDNURI": "string",
- "HumanError": "string",
- "Log": [
- {
- "At": "2019-08-24T14:15:22Z",
- "Data": { },
- "ID": 0,
- "Message": "string",
- "Status": "string"
}
], - "NotifyUserUUID": "a433fc8d-7a6c-4ad1-bf63-be27b82f5959",
- "OriginalModified": "2019-08-24T14:15:22Z",
- "OriginalName": "string",
- "OriginalSize": 0,
- "RuntimeArchitectures": [
- "string"
], - "Size": 0,
- "Status": "string",
- "TechError": "string",
- "Toolchain": "string",
- "UploaderUserUUID": "7e351b22-41d5-4c47-8a33-7907d6a838d7"
}, - "DisableConversions": [
- "string"
], - "Documentation": "string",
- "Downloads": [
- {
- "LastModified": "2019-08-24T14:15:22Z",
- "MD5": "string",
- "RuntimeArchitecture": "string",
- "Size": 0,
- "Url": "string"
}
], - "InputDriver": "string",
- "InputDriverDetails": { },
- "Name": "string",
- "NamedInput": { },
- "NamedOutput": { },
- "OutputDriver": "string",
- "OutputDriverDetails": { },
- "Source": {
- "Name": "string",
- "Url": "string"
}, - "Status": "string",
- "SyncInformation": {
- "EdgeImpulse": {
- "Active": true,
- "DownloadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedAt": "2019-08-24T14:15:22Z",
- "LastDataUploadedCount": 0,
- "LastDataUploading": true
}
}, - "UUID": "f50af7e0-0dd5-4361-ab96-2e04f7bc7e30",
- "UpdatedAt": "2019-08-24T14:15:22Z"
}
Return a list of options.
Time-out set to 5s. Requires an authenticated user.
[- {
- "InputProperties": [
- {
- "Name": "string"
}
], - "OutputProperties": [
- {
- "Name": "string"
}
], - "RuntimeArchitectures": [
- {
- "Type": "string"
}
], - "Sources": [
- {
- "Name": "string",
- "Url": "string"
}
], - "TensorSizes": [
- {
- "Height": "string",
- "Width": "string"
}
]
}
]
[- {
- "CurrentImageLocation": "string",
- "CurrentTag": "string",
- "CurrentTagCreatedAt": "2019-08-24T14:15:22Z",
- "CurrentTagDigest": "string",
- "InstalledAt": "2019-08-24T14:15:22Z"
}
]