{ "info": { "_postman_id": "18a553a8-db6b-4def-8ac8-74795392c9af", "name": "Edge Impulse API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "19901430" }, "item": [ { "name": "api", "item": [ { "name": "user", "item": [ { "name": "photo", "item": [ { "name": "Upload photo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "photo", "type": "file", "description": "(Required) ", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/user/photo", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "photo" ] }, "description": "Upload a photo for the current user. This function is only available through a JWT token. Don't trust the code generated by the widget, there are examples of using this API in Python, cURL and Node.js under the parameters." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "photo", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/user/photo", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "photo" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Delete photo", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/photo", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "photo" ] }, "description": "Delete user profile photo. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user/photo", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "photo" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] }, "description": "Get information about the current user. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": {\n \"value\": \"\"\n },\n \"activated\": {\n \"value\": \"\"\n },\n \"organizations\": {\n \"value\": \"\"\n },\n \"projects\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"showImagine2022\": {\n \"value\": \"\"\n },\n \"tier\": {\n \"value\": \"\"\n },\n \"evaluation\": {\n \"value\": \"\"\n },\n \"ambassador\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update current user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"showImagine2022\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] }, "description": "Update user properties such as name. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"showImagine2022\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete current user", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] }, "description": "Delete a user. This function is only available through a JWT token, and can only remove the current user." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Convert current evaluation user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"privacyPolicy\": \"\",\n \"projectName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/convert", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "convert" ] }, "description": "Convert current evaluation user account to regular account." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"password\": \"\",\n \"privacyPolicy\": \"\",\n \"projectName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/convert", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "convert" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Activate current user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "activate" ] }, "description": "Activate the current user account (requires an activation code). This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "activate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Request activation code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/request-activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "request-activation" ] }, "description": "Request a new activation code for the current user. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user/request-activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "request-activation" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Create developer profile", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/create-developer-profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-developer-profile" ] }, "description": "Create a developer profile for the current active user." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user/create-developer-profile", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "create-developer-profile" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organizationId\": {\n \"value\": \"\"\n },\n \"link\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List emails", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/emails", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "emails" ] }, "description": "Get a list of all emails sent by Edge Impulse to the current user. This function is only available through a JWT token, and is not available for all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user/emails", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "emails" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"emails\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Change password current user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/change-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "change-password" ] }, "description": "Change the password for the current user account. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/change-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "change-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get organizations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "organizations" ] }, "description": "List all organizations that the current user is a member of. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organizations\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get user by third party activation code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"activationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/by-third-party-activation-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "by-third-party-activation-code" ] }, "description": "Get information about a user through an activation code. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"activationCode\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/by-third-party-activation-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "by-third-party-activation-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": {\n \"value\": \"\"\n },\n \"activated\": {\n \"value\": \"\"\n },\n \"organizations\": {\n \"value\": \"\"\n },\n \"projects\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"showImagine2022\": {\n \"value\": \"\"\n },\n \"tier\": {\n \"value\": \"\"\n },\n \"evaluation\": {\n \"value\": \"\"\n },\n \"ambassador\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Activate user by third party activation code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"activationCode\": \"\",\n \"password\": \"\",\n \"username\": \"\",\n \"name\": \"\",\n \"privacyPolicy\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/activate-by-third-party-activation-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "activate-by-third-party-activation-code" ] }, "description": "Activate a user that was created by a third party. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"activationCode\": \"\",\n \"password\": \"\",\n \"username\": \"\",\n \"name\": \"\",\n \"privacyPolicy\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/user/activate-by-third-party-activation-code", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "activate-by-third-party-activation-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": {\n \"value\": \"\"\n },\n \"redirectUrl\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Accept Terms of Service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user/accept-tos", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "accept-tos" ] }, "description": "Accept Terms of Service." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/user/accept-tos", "host": [ "{{baseUrl}}" ], "path": [ "api", "user", "accept-tos" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "Get user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Get information about a user. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": {\n \"value\": \"\"\n },\n \"activated\": {\n \"value\": \"\"\n },\n \"organizations\": {\n \"value\": \"\"\n },\n \"projects\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"showImagine2022\": {\n \"value\": \"\"\n },\n \"tier\": {\n \"value\": \"\"\n },\n \"evaluation\": {\n \"value\": \"\"\n },\n \"ambassador\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"showImagine2022\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Update user properties such as name. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"showImagine2022\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete user", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Delete a user. This function is only available through a JWT token, and can only remove the current user." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Activate user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "activate" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Activate a user account (requires an activation code). This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId/activate", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "activate" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Request activation code", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/request-activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "request-activation" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Request a new activation code. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/request-activation", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "request-activation" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "List emails", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/emails", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "emails" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Get a list of all emails sent by Edge Impulse to a user. This function is only available through a JWT token, and is not available for all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/emails", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "emails" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"emails\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Upload photo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "photo", "value": "", "type": "text", "description": "(Required) " } ] }, "url": { "raw": "{{baseUrl}}/api/users/:userId/photo", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "photo" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Upload a photo for a user. This function is only available through a JWT token, and is not available for all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "photo", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/users/:userId/photo", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "photo" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Change password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId/change-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "change-password" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Change the password for a user account. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"currentPassword\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId/change-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "change-password" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Set password for SSO user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"\",\n \"identityProvider\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId/set-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "set-password" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Set the password for a new SSO user. This function is only available through an SSO access token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accessToken\": \"\",\n \"identityProvider\": \"\",\n \"password\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/users/:userId/set-password", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "set-password" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get organizations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "organizations" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "List all organizations for a user. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "organizations" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organizations\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get buckets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "buckets" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "List all organizational storage buckets that a user has access to. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/:userId/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", ":userId", "buckets" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"buckets\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Get buckets current user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/users/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", "buckets" ] }, "description": "List all organizational storage buckets that the current user has access to. This function is only available through a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/users/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "users", "buckets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"buckets\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "third-party-auth", "item": [ { "name": "{authId}", "item": [ { "name": "Get third party auth", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] }, "description": "Get information about a third party authentication partner" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"auth\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update third party auth", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] }, "description": "Update a third party authentication partner" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete third party auth", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] }, "description": "Delete a third party authentication partner" }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Create or login a user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"privacyPolicy\": \"\",\n \"projectName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId", "login" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] }, "description": "Login as a user as a third-party authentication provider. If the user does not exists, it's automatically created. You can only log in as users that were previously created by you." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"privacyPolicy\": \"\",\n \"projectName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/third-party-auth/:authId/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth", ":authId", "login" ], "variable": [ { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": {\n \"value\": \"\"\n },\n \"jwtToken\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Get all third party auth", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/third-party-auth", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth" ] }, "description": "Get information about all third party authentication partners" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/third-party-auth", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"auths\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create third party auth", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"secretKey\": \"\",\n \"apiKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/third-party-auth", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth" ] }, "description": "Create a new third party authentication partner" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"logo\": \"\",\n \"domains\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"secretKey\": \"\",\n \"apiKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/third-party-auth", "host": [ "{{baseUrl}}" ], "path": [ "api", "third-party-auth" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"secretKey\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "{projectId}", "item": [ { "name": "collaborators", "item": [ { "name": "Add collaborator", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/add", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "add" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Add a collaborator to a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/add", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "add" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove collaborator", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "remove" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Remove a collaborator to a project. Note that you cannot invoke this function if only a single collaborator is present." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "remove" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Transfer ownership (user)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/transfer-ownership", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "transfer-ownership" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Transfer ownership of a project to another user." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/transfer-ownership", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "transfer-ownership" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Transfer ownership (organization)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/transfer-ownership-org", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "transfer-ownership-org" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Transfer ownership of a project to another organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"organizationId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/collaborators/transfer-ownership-org", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "collaborators", "transfer-ownership-org" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "hmackeys", "item": [ { "name": "Get HMAC keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/hmackeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "hmackeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve all HMAC keys." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/hmackeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "hmackeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hmacKeys\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add HMAC key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"hmacKey\": \"\",\n \"isDevelopmentKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/hmackeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "hmackeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Add an HMAC key. If you set `developmentKey` to `true` this flag will be removed from the current development HMAC key." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"hmacKey\": \"\",\n \"isDevelopmentKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/hmackeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "hmackeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove HMAC key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/hmackeys/:hmacId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "hmackeys", ":hmacId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "hmacId", "value": "", "description": "(Required) Hmac key ID" } ] }, "description": "Revoke an HMAC key. Note that if you revoke the development key some services (such as automatic provisioning of devices through the serial daemon) will no longer work." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/hmackeys/:hmacId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "hmackeys", ":hmacId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "hmacId", "value": "", "description": "(Required) Hmac key ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "apikeys", "item": [ { "name": "Get API keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "apikeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve all API keys. This does **not** return the full API key, but only a portion (for security purposes). The development key will be returned in full, as it'll be set in devices and is thus not private." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "apikeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"apiKeys\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add API key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"isDevelopmentKey\": \"\",\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "apikeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Add an API key. If you set `developmentKey` to `true` this flag will be removed from the current development API key." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"isDevelopmentKey\": \"\",\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "apikeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Revoke API key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "apiKeyId", "value": "", "description": "(Required) API key ID" } ] }, "description": "Revoke an API key. Note that if you revoke the development API key some services (such as automatic provisioning of devices through the serial daemon) will no longer work." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "apiKeyId", "value": "", "description": "(Required) API key ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "versions", "item": [ { "name": "{versionId}", "item": [ { "name": "Update version", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", ":versionId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] }, "description": "Updates a version, this only updates fields that were set in the body." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", ":versionId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete versions", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", ":versionId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] }, "description": "Delete a version. This does not delete the version from cold storage." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions/:versionId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", ":versionId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Make version private", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions/:versionId/make-private", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", ":versionId", "make-private" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] }, "description": "Make a public version private." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions/:versionId/make-private", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", ":versionId", "make-private" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "List versions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all versions for this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"nextVersion\": {\n \"value\": \"\"\n },\n \"versions\": {\n \"value\": \"\"\n },\n \"customLearnBlocks\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List public versions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions/public", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", "public" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all public versions for this project. You don't need any authentication for this function." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/versions/public", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "versions", "public" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"versions\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "devices", "item": [ { "name": "Lists devices", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/devices", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devices" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "List all devices for this project. Devices get included here if they connect to the remote management API or if they have sent data to the ingestion API and had the `device_id` field set." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/devices", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devices" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"devices\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create device", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\",\n \"deviceType\": \"\",\n \"ifNotExists\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/devices/create", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devices", "create" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Create a new device. If you set `ifNotExists` to `false` and the device already exists, the `deviceType` will be overwritten." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\",\n \"deviceType\": \"\",\n \"ifNotExists\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/devices/create", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devices", "create" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Rename", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/devices/:deviceId/rename", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devices", ":deviceId", "rename" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] }, "description": "Set the current name for a device." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/devices/:deviceId/rename", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devices", ":deviceId", "rename" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "device/{deviceId}", "item": [ { "name": "Get device", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "device", ":deviceId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] }, "description": "Retrieves a single device" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "device", ":deviceId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"device\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Delete device", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "device", ":deviceId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] }, "description": "Delete a device. When this device sends a new message to ingestion or connects to remote management the device will be recreated." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/device/:deviceId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "device", ":deviceId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Start sampling", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"lengthMs\": \"\",\n \"category\": \"\",\n \"intervalMs\": \"\",\n \"sensor\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/device/:deviceId/start-sampling", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "device", ":deviceId", "start-sampling" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] }, "description": "Start sampling on a device. This function returns immediately. Updates are streamed through the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"lengthMs\": \"\",\n \"category\": \"\",\n \"intervalMs\": \"\",\n \"sensor\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/device/:deviceId/start-sampling", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "device", ":deviceId", "start-sampling" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "deviceId", "value": "", "description": "(Required) Device ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "raw-data", "item": [ { "name": "label-object-detection-queue", "item": [ { "name": "Object detection label queue", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/label-object-detection-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "label-object-detection-queue" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all unlabeled items from the object detection queue." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/label-object-detection-queue", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "label-object-detection-queue" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"samples\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Object detection label queue count", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/label-object-detection-queue/count", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "label-object-detection-queue", "count" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get count for unlabeled items from the object detection queue." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/label-object-detection-queue/count", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "label-object-detection-queue", "count" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"samplesCount\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "delete-all", "item": [ { "name": "Remove all samples", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/delete-all", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "delete-all" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Deletes all samples for this project over all categories. This also invalidates all DSP and learn blocks. Note that this does not delete the data from cold storage." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/delete-all", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "delete-all" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove all samples by category", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/delete-all/:category", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "delete-all", ":category" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] }, "description": "Deletes all samples for this project over a single category. Note that this does not delete the data from cold storage." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/delete-all/:category", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "delete-all", ":category" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "{sampleId}", "item": [ { "name": "Get sample", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId?limitPayloadValues=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId" ], "query": [ { "key": "limitPayloadValues", "value": "", "description": "Limit the number of payload values in the response" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get a sample." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId?limitPayloadValues=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId" ], "query": [ { "key": "limitPayloadValues", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Remove sample", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Deletes the sample. Note that this does not delete the data from cold storage." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Download file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/raw", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "raw" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Download a sample in it's original format as uploaded to the ingestion service." }, "response": [ { "name": "CBOR or JSON file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/raw", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "raw" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] }, { "name": "Get WAV file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "audio/wav" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/wav?axisIx=&sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "wav" ], "query": [ { "key": "axisIx", "value": "", "description": "(Required) Axis index" }, { "key": "sliceStart", "value": "", "description": "Begin index of the slice" }, { "key": "sliceEnd", "value": "", "description": "End index of the slice" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get a sample as a WAV file. This only applies to samples with an audio axis." }, "response": [ { "name": "Wav file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/wav?axisIx=&sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "wav" ], "query": [ { "key": "axisIx", "value": "" }, { "key": "sliceStart", "value": "" }, { "key": "sliceEnd", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "audio/wav" } ], "cookie": [], "body": "" } ] }, { "name": "Get image file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "image/jpeg" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/image?afterInputBlock=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "image" ], "query": [ { "key": "afterInputBlock", "value": "", "description": "Whether to process the image through the input block first" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get a sample as an image file. This only applies to samples with RGBA data." }, "response": [ { "name": "Image file (either JPEG or PNG format)", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/image?afterInputBlock=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "image" ], "query": [ { "key": "afterInputBlock", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/jpeg" } ], "cookie": [], "body": "" } ] }, { "name": "Get video file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "video/mp4" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/video?afterInputBlock=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "video" ], "query": [ { "key": "afterInputBlock", "value": "", "description": "Whether to process the image through the input block first" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get a sample as an video file. This only applies to samples with video data." }, "response": [ { "name": "Video file in AVI or MP4 format", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/video?afterInputBlock=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "video" ], "query": [ { "key": "afterInputBlock", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "video/mp4" } ], "cookie": [], "body": "" } ] }, { "name": "Get sample slice", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/slice?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "slice" ], "query": [ { "key": "sliceStart", "value": "", "description": "(Required) Begin index of the slice" }, { "key": "sliceEnd", "value": "", "description": "(Required) End index of the slice" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get a slice of a sample." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/slice?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "slice" ], "query": [ { "key": "sliceStart", "value": "" }, { "key": "sliceEnd", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Rename sample", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/rename", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "rename" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Sets the file name of the sample. This name does not need to be unique, but it's highly recommended to do so." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/rename", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "rename" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Edit label", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/edit-label", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "edit-label" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Sets the label (also known as class) of the sample. Use the same label for similar types of data, as they are used during training." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/edit-label", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "edit-label" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Move sample", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"newCategory\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/move", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "move" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Move a sample to another category (e.g. from test to training)." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"newCategory\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/move", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "move" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Crop sample", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"cropStart\": \"\",\n \"cropEnd\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/crop", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "crop" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Crop a sample to within a new range." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"cropStart\": \"\",\n \"cropEnd\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/crop", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "crop" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"requiresProcessing\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Split sample into frames", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fps\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/split", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "split" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Split a video sample into individual frames." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"fps\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/split", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "split" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Find segments", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shiftSegments\": \"\",\n \"segmentLengthMs\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/find-segments", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "find-segments" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Find start and end times for all non-noise events in a sample" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"shiftSegments\": \"\",\n \"segmentLengthMs\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/find-segments", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "find-segments" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"segments\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Segment sample", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"segments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/segment", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "segment" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Slice a sample into multiple segments. The original file will be marked as deleted, but you can crop any created segment to retrieve the original file." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"segments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/segment", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "segment" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Set bounding boxes", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"boundingBoxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/bounding-boxes", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "bounding-boxes" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Set the bounding boxes for a sample" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"boundingBoxes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/bounding-boxes", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "bounding-boxes" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Store the last segment length", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"segmentLength\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/store-segment-length", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "store-segment-length" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "When segmenting a sample into smaller segments, store the segment length to ensure uniform segment lengths." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"segmentLength\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/store-segment-length", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "store-segment-length" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get the original downsampled data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/original?limitPayloadValues=&zoomStart=&zoomEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "original" ], "query": [ { "key": "limitPayloadValues", "value": "", "description": "Limit the number of payload values in the response" }, { "key": "zoomStart", "value": "", "description": "Zoom into the sample, with the focus starting at this index" }, { "key": "zoomEnd", "value": "", "description": "Zoom into the sample, with the focus ending at this index" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get the original, uncropped, downsampled data." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/original?limitPayloadValues=&zoomStart=&zoomEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "original" ], "query": [ { "key": "limitPayloadValues", "value": "" }, { "key": "zoomStart", "value": "" }, { "key": "zoomEnd", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Retry processing", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/retry-processing", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "retry-processing" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "If a sample failed processing, retry the processing operation." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/retry-processing", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "retry-processing" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Enable sample", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/enable", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "enable" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Enable a sample, ensuring that it is not excluded from the dataset." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/enable", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "enable" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Disable sample", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/disable", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "disable" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Disable a sample, ensuring that it is excluded from the dataset." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/disable", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "disable" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Auto-label an image", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"neuralNetwork\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/autolabel", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "autolabel" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Classify an image using another neural network." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"neuralNetwork\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/autolabel", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "autolabel" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"results\": {\n \"value\": \"\"\n },\n \"allLabels\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Set sample metadata", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"metadata\": {\n \"commodo_15\": {\n \"value\": \"\"\n },\n \"ametbb\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Adds or updates the metadata associated to a sample." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"metadata\": {\n \"commodo_15\": {\n \"value\": \"\"\n },\n \"ametbb\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/:sampleId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", ":sampleId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "batch", "item": [ { "name": "Edit labels for multiple samples", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/edit-labels?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "edit-labels" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" }, { "key": "ids", "value": "", "description": "Only include samples with an ID within the given list of IDs, given as a JSON string" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Sets the label (also known as class) of multiple samples." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"label\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/edit-labels?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "edit-labels" ], "query": [ { "key": "category", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" }, { "key": "ids", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove multiple samples", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/delete?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "delete" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" }, { "key": "ids", "value": "", "description": "Only include samples with an ID within the given list of IDs, given as a JSON string" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Deletes samples. Note that this does not delete the data from cold storage." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/delete?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "delete" ], "query": [ { "key": "category", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" }, { "key": "ids", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Move multiple samples", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"newCategory\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/moveSamples?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "moveSamples" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" }, { "key": "ids", "value": "", "description": "Only include samples with an ID within the given list of IDs, given as a JSON string" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Move multiple samples to another category (e.g. from test to training)." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"newCategory\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/moveSamples?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "moveSamples" ], "query": [ { "key": "category", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" }, { "key": "ids", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Enable multiple samples", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/enable-samples?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "enable-samples" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" }, { "key": "ids", "value": "", "description": "Only include samples with an ID within the given list of IDs, given as a JSON string" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Enables samples, ensuring that they are not excluded from the dataset." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/enable-samples?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "enable-samples" ], "query": [ { "key": "category", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" }, { "key": "ids", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Disable multiple samples", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/disable-samples?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "disable-samples" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" }, { "key": "ids", "value": "", "description": "Only include samples with an ID within the given list of IDs, given as a JSON string" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Disables samples, ensuring that they are excluded from the dataset." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/batch/disable-samples?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=&ids=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "batch", "disable-samples" ], "query": [ { "key": "category", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" }, { "key": "ids", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "data-explorer", "item": [ { "name": "settings", "item": [ { "name": "Get data explorer settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "settings" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get data explorer configuration, like the type of data, and the input / dsp block to use." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "settings" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"dimensionalityReductionRecommendation\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Set data explorer settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"preset\": \"\",\n \"dimensionalityReductionTechnique\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "settings" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Set data explorer configuration, like the type of data, and the input / dsp block to use." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"preset\": \"\",\n \"dimensionalityReductionTechnique\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/settings", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "settings" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get data explorer features", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "t-SNE2 output of the raw dataset" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasFeatures\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"inputBlock\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Check data explorer features", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/has-features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "has-features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "t-SNE2 output of the raw dataset" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/has-features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "has-features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasFeatures\": {\n \"value\": \"\"\n },\n \"inputBlock\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get data explorer predictions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/predictions", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "predictions" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Predictions for every data explorer point (only available when using current impulse to populate data explorer)" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/predictions", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "predictions" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"predictions\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"classificationType\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Clear data explorer", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/clear", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "clear" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Remove the current data explorer state" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/clear", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "clear" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Upload a data explorer screenshot", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "", "type": "text", "description": "(Required) " } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/screenshot", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "screenshot" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Used internally (from a data pipeline) to upload a picture of the data explorer" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/data-explorer/screenshot", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "data-explorer", "screenshot" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "List samples", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data?category=&limit=&offset=&excludeSensors=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." }, { "key": "excludeSensors", "value": "", "description": "Whether to exclude sensors in the response (as these can slow down requests when you have large pages)." }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve all raw data by category." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data?category=&limit=&offset=&excludeSensors=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data" ], "query": [ { "key": "category", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "excludeSensors", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"samples\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Count samples", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/count?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "count" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" }, { "key": "labels", "value": "", "description": "Only include samples with a label within the given list of labels, given as a JSON string" }, { "key": "filename", "value": "", "description": "Only include samples whose filename includes the given filename" }, { "key": "maxLength", "value": "", "description": "Only include samples shorter than the given length, in milliseconds" }, { "key": "minLength", "value": "", "description": "Only include samples longer than the given length, in milliseconds" }, { "key": "minFrequency", "value": "", "description": "Only include samples with higher frequency than given frequency, in hertz" }, { "key": "maxFrequency", "value": "", "description": "Only include samples with lower frequency than given frequency, in hertz" }, { "key": "signatureValidity", "value": "", "description": "Include samples with either valid or invalid signatures" }, { "key": "includeDisabled", "value": "", "description": "Include only enabled or disabled samples (or both)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Count all raw data by category." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/count?category=&labels=&filename=&maxLength=&minLength=&minFrequency=&maxFrequency=&signatureValidity=&includeDisabled=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "count" ], "query": [ { "key": "category", "value": "" }, { "key": "labels", "value": "" }, { "key": "filename", "value": "" }, { "key": "maxLength", "value": "" }, { "key": "minLength", "value": "" }, { "key": "minFrequency", "value": "" }, { "key": "maxFrequency", "value": "" }, { "key": "signatureValidity", "value": "" }, { "key": "includeDisabled", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"count\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get project sample metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/metadata?category=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "metadata" ], "query": [ { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to retrieve data from" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get metadata for all samples in a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/metadata?category=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "metadata" ], "query": [ { "key": "category", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Track objects", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"sourceSampleId\": \"\",\n \"nextSampleId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/track-objects", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "track-objects" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Track objects between two samples. Source sample should have bounding boxes set." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"sourceSampleId\": \"\",\n \"nextSampleId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/raw-data/track-objects", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "raw-data", "track-objects" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"boundingBoxes\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "impulse", "item": [ { "name": "block-versions/{blockType}/{blockId}", "item": [ { "name": "Create new block version", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/block-versions/:blockType/:blockId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "block-versions", ":blockType", ":blockId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "blockType", "value": "", "description": "(Required) Type of block" }, { "key": "blockId", "value": "", "description": "(Required) Block ID" } ] }, "description": "Create a new version of a given block" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/block-versions/:blockType/:blockId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "block-versions", ":blockType", ":blockId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "blockType", "value": "", "description": "(Required) Type of block" }, { "key": "blockId", "value": "", "description": "(Required) Block ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update block version details", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"primaryVersion\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dsp\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"axes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"input\": \"\",\n \"windowSizeMs\": \"\",\n \"windowIncreaseMs\": \"\",\n \"frequencyHz\": \"\",\n \"classificationWindowIncreaseMs\": \"\",\n \"padZeros\": \"\",\n \"imageWidth\": \"\",\n \"imageHeight\": \"\",\n \"resizeMode\": \"\",\n \"resizeMethod\": \"\",\n \"cropAnchor\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/block-versions/:blockType/:blockId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "block-versions", ":blockType", ":blockId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "blockType", "value": "", "description": "(Required) Type of block" }, { "key": "blockId", "value": "", "description": "(Required) Block ID" } ] }, "description": "Update the details of a block version" }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"primaryVersion\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"dsp\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"axes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"input\": \"\",\n \"windowSizeMs\": \"\",\n \"windowIncreaseMs\": \"\",\n \"frequencyHz\": \"\",\n \"classificationWindowIncreaseMs\": \"\",\n \"padZeros\": \"\",\n \"imageWidth\": \"\",\n \"imageHeight\": \"\",\n \"resizeMode\": \"\",\n \"resizeMethod\": \"\",\n \"cropAnchor\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/block-versions/:blockType/:blockId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "block-versions", ":blockType", ":blockId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "blockType", "value": "", "description": "(Required) Type of block" }, { "key": "blockId", "value": "", "description": "(Required) Block ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get impulse", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve the impulse for this project" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"impulse\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create impulse", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"inputBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"learnBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/impulse", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Sets the impulse for this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"inputBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"learnBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/impulse", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete impulse", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Completely clears the impulse for this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get impulse including disabled blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/all", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "all" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve the impulse for this project including disabled blocks" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/all", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "all" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"impulse\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get impulse blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/blocks", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "blocks" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Lists all possible blocks that can be used in the impulse" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/impulse/blocks", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "impulse", "blocks" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"inputBlocks\": {\n \"value\": \"\"\n },\n \"dspBlocks\": {\n \"value\": \"\"\n },\n \"learnBlocks\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "dsp/{dspId}", "item": [ { "name": "raw-data/{sampleId}", "item": [ { "name": "slice", "item": [ { "name": "run", "item": [ { "name": "Get processed sample (slice)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"dolore65\": {\n \"value\": \"\"\n }\n },\n \"store\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId/slice/run?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId", "slice", "run" ], "query": [ { "key": "sliceStart", "value": "", "description": "(Required) Begin index of the slice" }, { "key": "sliceEnd", "value": "", "description": "(Required) End index of the slice" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"dolore65\": {\n \"value\": \"\"\n }\n },\n \"store\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId/slice/run?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId", "slice", "run" ], "query": [ { "key": "sliceStart", "value": "" }, { "key": "sliceEnd", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"features\": {\n \"value\": \"\"\n },\n \"graphs\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"sample\": {\n \"value\": \"\"\n },\n \"canProfilePerformance\": {\n \"value\": \"\"\n },\n \"performance\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get processed sample (slice)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId/slice/run/readonly?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId", "slice", "run", "readonly" ], "query": [ { "key": "sliceStart", "value": "", "description": "(Required) Begin index of the slice" }, { "key": "sliceEnd", "value": "", "description": "(Required) End index of the slice" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get slice of sample data, and run it through the DSP block. This only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId/slice/run/readonly?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId", "slice", "run", "readonly" ], "query": [ { "key": "sliceStart", "value": "" }, { "key": "sliceEnd", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"features\": {\n \"value\": \"\"\n },\n \"graphs\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n },\n \"sample\": {\n \"value\": \"\"\n },\n \"canProfilePerformance\": {\n \"value\": \"\"\n },\n \"performance\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Get raw sample (slice)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId/slice?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId", "slice" ], "query": [ { "key": "sliceStart", "value": "", "description": "(Required) Begin index of the slice" }, { "key": "sliceEnd", "value": "", "description": "(Required) End index of the slice" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get slice of raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId/slice?sliceStart=&sliceEnd=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId", "slice" ], "query": [ { "key": "sliceStart", "value": "" }, { "key": "sliceEnd", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "Get raw sample", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId?limitPayloadValues=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId" ], "query": [ { "key": "limitPayloadValues", "value": "", "description": "Limit the number of payload values in the response" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get raw sample data, but with only the axes selected by the DSP block. E.g. if you have selected only accX and accY as inputs for the DSP block, but the raw sample also contains accZ, accZ is filtered out. If you pass dspId = 0 this will return a raw graph without any processing." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/raw-data/:sampleId?limitPayloadValues=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "raw-data", ":sampleId" ], "query": [ { "key": "limitPayloadValues", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "features", "item": [ { "name": "get-graph", "item": [ { "name": "Sample of trained features", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/get-graph/:category?featureAx1=&featureAx2=&featureAx3=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "get-graph", ":category" ], "query": [ { "key": "featureAx1", "value": "", "description": "(Required) Feature axis 1" }, { "key": "featureAx2", "value": "", "description": "(Required) Feature axis 2" }, { "key": "featureAx3", "value": "", "description": "(Required) Feature axis 3" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] }, "description": "Get a sample of trained features, this extracts a number of samples and their labels. Used to visualize the current training set." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/get-graph/:category?featureAx1=&featureAx2=&featureAx3=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "get-graph", ":category" ], "query": [ { "key": "featureAx1", "value": "" }, { "key": "featureAx2", "value": "" }, { "key": "featureAx3", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalSampleCount\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"skipFirstFeatures\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Features for sample", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/get-graph/classification/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "get-graph", "classification", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Runs the DSP block against a sample. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and run the DSP function for every window that is extracted." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/get-graph/classification/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "get-graph", "classification", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalSampleCount\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"skipFirstFeatures\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Feature labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "labels" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Retrieve the names of the features the DSP block generates" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/labels", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "labels" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"labels\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Feature importance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/importance", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "importance" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Retrieve the feature importance for a DSP block (only available for blocks where dimensionalityReduction is not enabled)" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/features/importance", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "features", "importance" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasFeatureImportance\": {\n \"value\": \"\"\n },\n \"labels\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Get config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Retrieve the configuration parameters for the DSP block. Use the impulse functions to retrieve all DSP blocks." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"dsp\": {\n \"value\": \"\"\n },\n \"config\": {\n \"value\": \"\"\n },\n \"configError\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Set config", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"config\": {\n \"minim_69_\": {\n \"value\": \"\"\n },\n \"cupidatat_6\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Set configuration parameters for the DSP block. Only values set in the body will be overwritten." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"config\": {\n \"minim_69_\": {\n \"value\": \"\"\n },\n \"cupidatat_6\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Clear DSP block", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/clear", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "clear" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Clear generated features for a DSP block (used in tests)." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/clear", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "clear" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Retrieve the metadata from a generated DSP block." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Get results from DSP autotuner", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/get-autotuner-results", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "get-autotuner-results" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Get a set of parameters, found as a result of running the DSP autotuner." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/get-autotuner-results", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "get-autotuner-results" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"results\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Profile custom DSP block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"sint_9d8\": {\n \"value\": \"\"\n },\n \"Lorem1d\": {\n \"value\": \"\"\n },\n \"consequat2\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "profile" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Returns performance characteristics for a custom DSP block (needs `hasTfliteImplementation`). Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"sint_9d8\": {\n \"value\": \"\"\n },\n \"Lorem1d\": {\n \"value\": \"\"\n },\n \"consequat2\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp/:dspId/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp", ":dspId", "profile" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "dsp-data/{dspId}", "item": [ { "name": "Download DSP data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp-data/:dspId/x/:category?raw=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp-data", ":dspId", "x", ":category" ], "query": [ { "key": "raw", "value": "", "description": "Whether to download raw data or processed data. Processed data is the default." } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] }, "description": "Download output from a DSP block over all data in the training set, already sliced in windows. In Numpy binary format." }, "response": [ { "name": "Numpy binary file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp-data/:dspId/x/:category?raw=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp-data", ":dspId", "x", ":category" ], "query": [ { "key": "raw", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] }, { "name": "Download DSP labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp-data/:dspId/y/:category", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp-data", ":dspId", "y", ":category" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] }, "description": "Download labels for a DSP block over all data in the training set, already sliced in windows." }, "response": [ { "name": "Numpy binary file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/dsp-data/:dspId/y/:category", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp-data", ":dspId", "y", ":category" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" }, { "key": "category", "value": "", "description": "(Required) Which of the three acquisition categories to download data from" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] } ] }, { "name": "training", "item": [ { "name": "{learnId}", "item": [ { "name": "Download data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/:learnId/x", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", ":learnId", "x" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Download the processed data for this learning block. This is data already processed by the signal processing blocks." }, "response": [ { "name": "Numpy binary file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/:learnId/x", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", ":learnId", "x" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] }, { "name": "Download labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/:learnId/y", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", ":learnId", "y" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Download the labels for this learning block. This is data already processed by the signal processing blocks. Not all blocks support this function. If so, a GenericApiResponse is returned with an error message." }, "response": [ { "name": "Numpy binary file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/:learnId/y", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", ":learnId", "y" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] } ] }, { "name": "anomaly/{learnId}", "item": [ { "name": "features/get-graph", "item": [ { "name": "Trained features", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId/features/get-graph?featureAx1=&featureAx2=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId", "features", "get-graph" ], "query": [ { "key": "featureAx1", "value": "", "description": "(Required) Feature axis 1" }, { "key": "featureAx2", "value": "", "description": "(Required) Feature axis 2" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Get a sample of trained features, this extracts a number of samples and their features." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId/features/get-graph?featureAx1=&featureAx2=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId", "features", "get-graph" ], "query": [ { "key": "featureAx1", "value": "" }, { "key": "featureAx2", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalSampleCount\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Trained features for sample", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId/features/get-graph/classification/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId", "features", "get-graph", "classification", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Get trained features for a single sample. This runs both the DSP prerequisites and the anomaly classifier." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId/features/get-graph/classification/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId", "features", "get-graph", "classification", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalSampleCount\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Anomaly information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Get information about an anomaly block, such as its dependencies. Use the impulse blocks to find the learnId." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": {\n \"value\": \"\"\n },\n \"axes\": {\n \"value\": \"\"\n },\n \"trained\": {\n \"value\": \"\"\n },\n \"dependencies\": {\n \"value\": \"\"\n },\n \"clusterCount\": {\n \"value\": \"\"\n },\n \"selectedAxes\": {\n \"value\": \"\"\n },\n \"minimumConfidenceRating\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Anomaly settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minimumConfidenceRating\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Configure the anomaly block, such as its minimum confidence score. Use the impulse blocks to find the learnId." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"minimumConfidenceRating\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Anomaly metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Get metadata about a trained anomaly block. Use the impulse blocks to find the learnId." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/anomaly/:learnId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "anomaly", ":learnId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "keras/{learnId}", "item": [ { "name": "Keras information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Get information about a Keras block, such as its dependencies. Use the impulse blocks to find the learnId." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"dependencies\": {\n \"value\": \"\"\n },\n \"trained\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"script\": {\n \"value\": \"\"\n },\n \"minimumConfidenceRating\": {\n \"value\": \"\"\n },\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n },\n \"trainingCycles\": {\n \"value\": \"\"\n },\n \"learningRate\": {\n \"value\": \"\"\n },\n \"visualLayers\": {\n \"value\": \"\"\n },\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"transferLearningModels\": {\n \"value\": \"\"\n },\n \"shape\": {\n \"value\": \"\"\n },\n \"profileInt8\": {\n \"value\": \"\"\n },\n \"skipEmbeddingsAndMemory\": {\n \"value\": \"\"\n },\n \"type\": {\n \"value\": \"\"\n },\n \"trainTestSplit\": {\n \"value\": \"\"\n },\n \"autoClassWeights\": {\n \"value\": \"\"\n },\n \"findLearningRate\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"customValidationMetadataKey\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Keras settings", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"minimumConfidenceRating\": \"\",\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"script\": \"\",\n \"visualLayers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"learningRate\": \"\",\n \"trainTestSplit\": \"\",\n \"autoClassWeights\": \"\",\n \"findLearningRate\": \"\",\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"profileInt8\": \"\",\n \"skipEmbeddingsAndMemory\": \"\",\n \"customValidationMetadataKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Configure the Keras block, such as its minimum confidence score. Use the impulse blocks to find the learnId." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"minimumConfidenceRating\": \"\",\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"script\": \"\",\n \"visualLayers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"learningRate\": \"\",\n \"trainTestSplit\": \"\",\n \"autoClassWeights\": \"\",\n \"findLearningRate\": \"\",\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"profileInt8\": \"\",\n \"skipEmbeddingsAndMemory\": \"\",\n \"customValidationMetadataKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Keras metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Get metadata about a trained Keras block. Use the impulse blocks to find the learnId." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "metadata" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"created\": {\n \"value\": \"\"\n },\n \"layers\": {\n \"value\": \"\"\n },\n \"classNames\": {\n \"value\": \"\"\n },\n \"availableModelTypes\": {\n \"value\": \"\"\n },\n \"recommendedModelType\": {\n \"value\": \"\"\n },\n \"modelValidationMetrics\": {\n \"value\": \"\"\n },\n \"hasTrainedModel\": {\n \"value\": \"\"\n },\n \"mode\": {\n \"value\": \"\"\n },\n \"objectDetectionLastLayer\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get data explorer features", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/data-explorer/features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "data-explorer", "features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "t-SNE2 output of the raw dataset using embeddings from this Keras block" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/data-explorer/features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "data-explorer", "features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasFeatures\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"inputBlock\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Upload Keras files", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "zip", "type": "file", "description": "(Required) ", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "files" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Replace Keras block files with the contents of a zip. This is an internal API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "zip", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "files" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Download Keras export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/zip" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/download-export", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "download-export" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Download an exported Keras block - needs to be exported via 'exportKerasBlock' first" }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/download-export", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "download-export" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/zip" } ], "cookie": [], "body": "" } ] }, { "name": "Download Keras data export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/zip" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/download-data", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "download-data" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Download the data of an exported Keras block - needs to be exported via 'exportKerasBlockData' first" }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/training/keras/:learnId/download-data", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "training", "keras", ":learnId", "download-data" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/zip" } ], "cookie": [], "body": "" } ] } ] } ] }, { "name": "pretrained-model", "item": [ { "name": "Get pretrained model", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Receive info back about the earlier uploaded pretrained model (via `uploadPretrainedModel`) input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"model\": {\n \"value\": \"\"\n },\n \"modelInfo\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Upload a pretrained model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "modelFile", "type": "file", "description": "(Required) ", "value": null }, { "key": "modelFileName", "value": "", "type": "text", "description": "(Required) " }, { "key": "modelFileType", "value": "", "type": "text", "description": "(Required) (This can only be one of tflite)" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "upload" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Upload a pretrained model and receive info back about the input/output tensors. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "modelFile", "value": "", "type": "text" }, { "description": "(Required) ", "key": "modelFileName", "value": "", "type": "text" }, { "description": "(Required) (This can only be one of tflite)", "key": "modelFileType", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "upload" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"model\": {\n \"value\": \"\"\n },\n \"modelInfo\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Save parameters for pretrained model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"value\": \"\"\n },\n \"model\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/save", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "save" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Save input / model configuration for a pretrained model. This overrides the current impulse. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"input\": {\n \"value\": \"\"\n },\n \"model\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/save", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "save" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Test pretrained model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"features\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelInfo\": {\n \"input\": {\n \"value\": \"\"\n },\n \"model\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/test", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "test" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Test out a pretrained model (using raw features) - upload first via `uploadPretrainedModel`. If you want to deploy a pretrained model from the API, see `startDeployPretrainedModelJob`." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"features\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelInfo\": {\n \"input\": {\n \"value\": \"\"\n },\n \"model\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/test", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "test" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"result\": {\n \"value\": \"\"\n },\n \"boundingBoxes\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Profile pretrained model", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "profile" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Returns the latency, RAM and ROM used for the pretrained model - upload first via `uploadPretrainedModel`. This is using the project's selected latency device. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/pretrained-model/profile", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "pretrained-model", "profile" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "classify", "item": [ { "name": "Classify sample", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/classify/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "classify", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] }, "description": "Classify a complete file against the current impulse. This will move the sliding window (dependent on the sliding window length and the sliding window increase parameters in the impulse) over the complete file, and classify for every window that is extracted." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/classify/:sampleId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "classify", ":sampleId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "sampleId", "value": "", "description": "(Required) Sample ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"classifications\": {\n \"value\": \"\"\n },\n \"sample\": {\n \"value\": \"\"\n },\n \"windowSizeMs\": {\n \"value\": \"\"\n },\n \"windowIncreaseMs\": {\n \"value\": \"\"\n },\n \"alreadyInDatabase\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Classify job result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/classify/all/result", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "classify", "all", "result" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get classify job result, containing the result for the complete testing dataset." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/classify/all/result", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "classify", "all", "result" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"result\": {\n \"value\": \"\"\n },\n \"predictions\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "performance-calibration", "item": [ { "name": "parameters", "item": [ { "name": "Get parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameters" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get performance calibration stored parameters" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameters" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"params\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Save performance calibration parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameters" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Set the current performance calibration parameters" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"params\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameters" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Clear performance calibration parameters", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameters" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Clears the current performance calibration parameters" }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameters", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameters" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/status", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "status" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get performance calibration status" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/status", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "status" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"available\": {\n \"value\": \"\"\n },\n \"unsupportedProjectError\": {\n \"value\": \"\"\n },\n \"options\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get ground truth", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/ground-truth", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "ground-truth" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get performance calibration ground truth data" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/ground-truth", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "ground-truth" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"samples\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get raw result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/raw-result", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "raw-result" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get performance calibration raw result" }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/raw-result", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "raw-result" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"detections\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get parameter sets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameter-sets", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameter-sets" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get performance calibration parameter sets" }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/parameter-sets", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "parameter-sets" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parameterSets\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get WAV file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "audio/wav" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/wav", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "wav" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get the synthetic sample as a WAV file" }, "response": [ { "name": "Wav file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/wav", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "wav" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "audio/wav" } ], "cookie": [], "body": "" } ] }, { "name": "Upload Performance Calibration Audio files", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "zip", "type": "file", "description": "(Required) ", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/files", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "files" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Upload a zip files with a wav file and its Label metadata to run performance calibration on it." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "zip", "type": "file" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/performance-calibration/files", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "performance-calibration", "files" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uploadKey\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "deployment", "item": [ { "name": "targets", "item": [ { "name": "Deployment targets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/targets", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "targets" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "List deployment targets for a project" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/targets", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "targets" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"targets\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Deployment targets (data sources)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/targets/data-sources", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "targets", "data-sources" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "List deployment targets for a project from data sources page (it shows some things like all Linux deploys, and hides 'fake' deploy targets like mobile phone / computer)" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/targets/data-sources", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "targets", "data-sources" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"targets\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "evaluate", "item": [ { "name": "Evaluate job result", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "evaluate" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get evaluate job result, containing detailed performance statistics for every possible variant of the impulse." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "evaluate" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"result\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Check evaluate job result (cache)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/evaluate/cache", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "evaluate", "cache" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get evaluate job result, containing detailed performance statistics for every possible variant of the impulse. This only checks cache, and throws an error if there is no data in cache." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/evaluate/cache", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "evaluate", "cache" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"result\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "syntiant/posterior", "item": [ { "name": "Get Syntiant posterior parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/syntiant/posterior", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "syntiant", "posterior" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get the current posterior parameters for the Syntiant deployment target" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/syntiant/posterior", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "syntiant", "posterior" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasPosteriorParameters\": {\n \"value\": \"\"\n },\n \"parameters\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Set Syntiant posterior parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/syntiant/posterior", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "syntiant", "posterior" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Set the current posterior parameters for the Syntiant deployment target" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"parameters\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/syntiant/posterior", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "syntiant", "posterior" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get deployment info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment?type=&modelType=&engine=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment" ], "query": [ { "key": "type", "value": "", "description": "(Required) The name of the built target. You can find this by listing all deployment targets through `listDeploymentTargetsForProject` (via `GET /v1/api/{projectId}/deployment/targets`) and see the `format` type." }, { "key": "modelType", "value": "", "description": "Optional model type of the build (if not, it uses the settings in the Keras block)" }, { "key": "engine", "value": "", "description": "Optional engine for the build (if not, it uses the default engine for the deployment target)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Gives information on whether a deployment was already built for a type" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment?type=&modelType=&engine=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment" ], "query": [ { "key": "type", "value": "" }, { "key": "modelType", "value": "" }, { "key": "engine", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasDeployment\": {\n \"value\": \"\"\n },\n \"version\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Download", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/zip" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/download?type=&modelType=&engine=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "download" ], "query": [ { "key": "type", "value": "", "description": "(Required) The name of the built target. You can find this by listing all deployment targets through `listDeploymentTargetsForProject` (via `GET /v1/api/{projectId}/deployment/targets`) and see the `format` type." }, { "key": "modelType", "value": "", "description": "Optional model type of the build (if not, it uses the settings in the Keras block)" }, { "key": "engine", "value": "", "description": "Optional engine for the build (if not, it uses the default engine for the deployment target)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Download the build artefacts for a project" }, "response": [ { "name": "ZIP or BIN file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/deployment/download?type=&modelType=&engine=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "deployment", "download" ], "query": [ { "key": "type", "value": "" }, { "key": "modelType", "value": "" }, { "key": "engine", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/zip" } ], "cookie": [], "body": "" } ] } ] }, { "name": "jobs", "item": [ { "name": "{jobId}", "item": [ { "name": "stdout", "item": [ { "name": "Get logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/stdout?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "stdout" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "logLevel", "value": "", "description": "Log level (error, warn, info, debug)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Get the logs for a job." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/stdout?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "stdout" ], "query": [ { "key": "limit", "value": "" }, { "key": "logLevel", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"stdout\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Download logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/plain" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/stdout/download?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "stdout", "download" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "logLevel", "value": "", "description": "Log level (error, warn, info, debug)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Download the logs for a job (as a text file)." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/stdout/download?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "stdout", "download" ], "query": [ { "key": "limit", "value": "" }, { "key": "logLevel", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Update job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"jobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/update", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "update" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Update a job." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"jobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/update", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "update" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get job status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/status", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "status" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Get the status for a job." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/status", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "status" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"job\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Cancel job", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/cancel?forceCancel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "cancel" ], "query": [ { "key": "forceCancel", "value": "", "description": "If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished." } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Cancel a running job." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/:jobId/cancel?forceCancel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", ":jobId", "cancel" ], "query": [ { "key": "forceCancel", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "train", "item": [ { "name": "keras/{learnId}", "item": [ { "name": "Train model (Keras)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"minimumConfidenceRating\": \"\",\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"script\": \"\",\n \"visualLayers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"learningRate\": \"\",\n \"trainTestSplit\": \"\",\n \"autoClassWeights\": \"\",\n \"findLearningRate\": \"\",\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"profileInt8\": \"\",\n \"skipEmbeddingsAndMemory\": \"\",\n \"customValidationMetadataKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/keras/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "keras", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Take the output from a DSP block and train a neural network using Keras. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"minimumConfidenceRating\": \"\",\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"script\": \"\",\n \"visualLayers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"learningRate\": \"\",\n \"trainTestSplit\": \"\",\n \"autoClassWeights\": \"\",\n \"findLearningRate\": \"\",\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"profileInt8\": \"\",\n \"skipEmbeddingsAndMemory\": \"\",\n \"customValidationMetadataKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/keras/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "keras", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Export Keras block", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/keras/:learnId/export", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "keras", ":learnId", "export" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Export the training pipeline of a Keras block. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/keras/:learnId/export", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "keras", ":learnId", "export" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Export Keras block data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/keras/:learnId/data", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "keras", ":learnId", "data" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Export the data of a Keras block (already split in train/validate data). Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/keras/:learnId/data", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "keras", ":learnId", "data" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Train model (Anomaly)", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"clusterCount\": \"\",\n \"minimumConfidenceRating\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/anomaly/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "anomaly", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Take the output from a DSP block and train an anomaly detection model using K-means. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"axes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"clusterCount\": \"\",\n \"minimumConfidenceRating\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/train/anomaly/:learnId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "train", "anomaly", ":learnId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "build-ondevice-model", "item": [ { "name": "Build on-device model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"engine\": {\n \"value\": \"\"\n },\n \"modelType\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/build-ondevice-model?type=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "build-ondevice-model" ], "query": [ { "key": "type", "value": "", "description": "(Required) The name of the built target. You can find this by listing all deployment targets through `listDeploymentTargetsForProject` (via `GET /v1/api/{projectId}/deployment/targets`) and see the `format` type." } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Generate code to run the impulse on an embedded device. When this step is complete use `downloadBuild` to download the artefacts. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"engine\": {\n \"value\": \"\"\n },\n \"modelType\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/build-ondevice-model?type=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "build-ondevice-model" ], "query": [ { "key": "type", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Build organizational on-device model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"engine\": {\n \"value\": \"\"\n },\n \"deployBlockId\": \"\",\n \"modelType\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/build-ondevice-model/organization", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "build-ondevice-model", "organization" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Generate code to run the impulse on an embedded device using an organizational deployment block. When this step is complete use `downloadBuild` to download the artefacts. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"engine\": {\n \"value\": \"\"\n },\n \"deployBlockId\": \"\",\n \"modelType\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/build-ondevice-model/organization", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "build-ondevice-model", "organization" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "export", "item": [ { "name": "Export original data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uploaderFriendlyFilenames\": \"\",\n \"retainCrops\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/export/original", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "export", "original" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Export all the data in the project as it was uploaded to Edge Impulse. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"uploaderFriendlyFilenames\": \"\",\n \"retainCrops\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/export/original", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "export", "original" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Export data as WAV", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"retainCrops\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/export/wav", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "export", "wav" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Export all the data in the project in WAV format. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"retainCrops\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/export/wav", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "export", "wav" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "restore", "item": [ { "name": "Restore project to version", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"\",\n \"projectApiKey\": \"\",\n \"versionId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/restore", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "restore" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Restore a project to a certain version. This can only applied to a project without data, and will overwrite your impulse and all settings." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"\",\n \"projectApiKey\": \"\",\n \"versionId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/restore", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "restore" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Restore project to public version", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/restore/from-public", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "restore", "from-public" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Restore a project to a certain public version. This can only applied to a project without data, and will overwrite your impulse and all settings." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/restore/from-public", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "restore", "from-public" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "profile-tflite", "item": [ { "name": "Profile TFLite model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tfliteFileBase64\": \"\",\n \"device\": \"\",\n \"referenceModel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/profile-tflite", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "profile-tflite" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Takes in a TFLite model and returns the latency, RAM and ROM used for this model. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tfliteFileBase64\": \"\",\n \"device\": \"\",\n \"referenceModel\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/profile-tflite", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "profile-tflite" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get TFLite profile result", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/profile-tflite/:jobId/result", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "profile-tflite", ":jobId", "result" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Get the results from a job started from startProfileTfliteJob." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/profile-tflite/:jobId/result", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "profile-tflite", ":jobId", "result" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "List active jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs?rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs" ], "query": [ { "key": "rootOnly", "value": "", "description": "Whether to exclude jobs with a parent ID (so jobs started as part of another job)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all active jobs for this project" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs?rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs" ], "query": [ { "key": "rootOnly", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Find Syntiant posterior parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "targetWords", "value": "[{\"value\":\"\"},{\"value\":\"\"}]", "type": "text", "description": "(Required) " }, { "key": "referenceSet", "value": "", "type": "text", "description": "(Required) (This can only be one of 600_seconds,full,custom,no_calibration)" }, { "key": "wavFile", "type": "file", "value": null }, { "key": "metaCsvFile", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/find-syntiant-posterior", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "find-syntiant-posterior" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Automatically find the current posterior parameters for the Syntiant deployment target" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "targetWords", "value": "[\"\",\"\"]", "type": "text" }, { "description": "(Required) (This can only be one of 600_seconds,full,custom,no_calibration)", "key": "referenceSet", "value": "", "type": "text" }, { "key": "wavFile", "value": "", "type": "text" }, { "key": "metaCsvFile", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/find-syntiant-posterior", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "find-syntiant-posterior" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Generate data explorer features", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/data-explorer-features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "data-explorer-features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Generate features for the data explorer" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/data-explorer-features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "data-explorer-features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Optimize model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"minimumConfidenceRating\": \"\",\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"script\": \"\",\n \"visualLayers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"learningRate\": \"\",\n \"trainTestSplit\": \"\",\n \"autoClassWeights\": \"\",\n \"findLearningRate\": \"\",\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"profileInt8\": \"\",\n \"skipEmbeddingsAndMemory\": \"\",\n \"customValidationMetadataKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/optimize", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "optimize" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Evaluates optimal model architecture" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"\",\n \"minimumConfidenceRating\": \"\",\n \"selectedModelType\": {\n \"value\": \"\"\n },\n \"script\": \"\",\n \"visualLayers\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"learningRate\": \"\",\n \"trainTestSplit\": \"\",\n \"autoClassWeights\": \"\",\n \"findLearningRate\": \"\",\n \"augmentationPolicyImage\": {\n \"value\": \"\"\n },\n \"augmentationPolicySpectrogram\": {\n \"value\": \"\"\n },\n \"profileInt8\": \"\",\n \"skipEmbeddingsAndMemory\": \"\",\n \"customValidationMetadataKey\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/optimize", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "optimize" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Sets EON tuner primary model", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/set-tuner-primary-job?trialId=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "set-tuner-primary-job" ], "query": [ { "key": "trialId", "value": "", "description": "(Required) trial ID" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Sets EON tuner primary model" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/set-tuner-primary-job?trialId=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "set-tuner-primary-job" ], "query": [ { "key": "trialId", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List finished jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/history?startDate=&endDate=&limit=&offset=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "history" ], "query": [ { "key": "startDate", "value": "", "description": "Start date" }, { "key": "endDate", "value": "", "description": "End date" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." }, { "key": "rootOnly", "value": "", "description": "Whether to exclude jobs with a parent ID (so jobs started as part of another job)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all finished jobs for this project" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/history?startDate=&endDate=&limit=&offset=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "history" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "rootOnly", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List all jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/all?startDate=&endDate=&limit=&offset=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "all" ], "query": [ { "key": "startDate", "value": "", "description": "Start date" }, { "key": "endDate", "value": "", "description": "End date" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." }, { "key": "rootOnly", "value": "", "description": "Whether to exclude jobs with a parent ID (so jobs started as part of another job)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all jobs for this project" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/all?startDate=&endDate=&limit=&offset=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "all" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "rootOnly", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Job summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/summary?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "summary" ], "query": [ { "key": "startDate", "value": "", "description": "(Required) Start date" }, { "key": "endDate", "value": "", "description": "(Required) End date" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get a summary of jobs, grouped by key. Used to report to users how much compute they've used." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/summary?startDate=&endDate=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "summary" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"summary\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Generate features", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dspId\": \"\",\n \"calculateFeatureImportance\": \"\",\n \"skipFeatureExplorer\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/generate-features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "generate-features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Take the raw training set and generate features from them. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dspId\": \"\",\n \"calculateFeatureImportance\": \"\",\n \"skipFeatureExplorer\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/generate-features", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "generate-features" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Autotune DSP parameters", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dspId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/autotune-dsp", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "autotune-dsp" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Autotune DSP block parameters. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dspId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/autotune-dsp", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "autotune-dsp" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Retrain", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/retrain", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "retrain" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrains the current impulse with the last known parameters. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/retrain", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "retrain" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Classify", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/classify", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "classify" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/classify", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "classify" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Performance Calibration", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"backgroundNoiseLabel\": \"\",\n \"otherNoiseLabels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"uploadKey\": \"\",\n \"sampleLengthMinutes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/performance-calibration", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "performance-calibration" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Simulates real world usage and returns performance metrics." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"backgroundNoiseLabel\": \"\",\n \"otherNoiseLabels\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"uploadKey\": \"\",\n \"sampleLengthMinutes\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/performance-calibration", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "performance-calibration" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Evaluate", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "evaluate" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Evaluates every variant of the current impulse. Updates are streamed over the websocket API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/evaluate", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "evaluate" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Version project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"makePublic\": \"\",\n \"bucketId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/version", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "version" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Create a new version of the project. This stores all data and configuration offsite. If you have access to the enterprise version of Edge Impulse you can store your data in your own storage buckets (only through JWT token authentication)." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"makePublic\": \"\",\n \"bucketId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/version", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "version" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Make a version public", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/versions/:versionId/make-public", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "versions", ":versionId", "make-public" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] }, "description": "Make a version of a project public. This makes all data and state available (read-only) on a public URL, and allows users to clone this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/versions/:versionId/make-public", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "versions", ":versionId", "make-public" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "versionId", "value": "", "description": "(Required) Version ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add keywords and noise", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/keywords-noise", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "keywords-noise" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Add keywords and noise data to a project (for getting started guide)" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/keywords-noise", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "keywords-noise" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Deploy pretrained model", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"modelFileBase64\": \"\",\n \"modelFileType\": \"\",\n \"deploymentType\": \"\",\n \"modelInfo\": {\n \"input\": {\n \"value\": \"\"\n },\n \"model\": {\n \"value\": \"\"\n }\n },\n \"engine\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/deploy-pretrained-model", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "deploy-pretrained-model" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Takes in a TFLite file and builds the model and SDK. Updates are streamed over the websocket API (or can be retrieved through the /stdout endpoint). Use getProfileTfliteJobResult to get the results when the job is completed." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"modelFileBase64\": \"\",\n \"modelFileType\": \"\",\n \"deploymentType\": \"\",\n \"modelInfo\": {\n \"input\": {\n \"value\": \"\"\n },\n \"model\": {\n \"value\": \"\"\n }\n },\n \"engine\": {\n \"value\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/jobs/deploy-pretrained-model", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "jobs", "deploy-pretrained-model" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "optimize", "item": [ { "name": "config", "item": [ { "name": "Get config", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/config", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "config" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get config" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/config", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "config" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"device\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update config", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"datasetCategory\": \"\",\n \"classificationType\": \"\",\n \"targetLatency\": \"\",\n \"targetDevice\": {\n \"name\": {\n \"value\": \"\"\n },\n \"ram\": {\n \"value\": \"\"\n },\n \"rom\": {\n \"value\": \"\"\n }\n },\n \"compiler\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"precision\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"tuningMaxTrials\": \"\",\n \"tuningWorkers\": \"\",\n \"minMACCS\": \"\",\n \"maxMACCS\": \"\",\n \"tuningAlgorithm\": \"\",\n \"notificationOnCompletion\": \"\",\n \"tunerSpaceOptions\": \"\",\n \"space\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/config", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "config" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Update config" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"datasetCategory\": \"\",\n \"classificationType\": \"\",\n \"targetLatency\": \"\",\n \"targetDevice\": {\n \"name\": {\n \"value\": \"\"\n },\n \"ram\": {\n \"value\": \"\"\n },\n \"rom\": {\n \"value\": \"\"\n }\n },\n \"compiler\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"precision\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"trainingCycles\": \"\",\n \"tuningMaxTrials\": \"\",\n \"tuningWorkers\": \"\",\n \"minMACCS\": \"\",\n \"maxMACCS\": \"\",\n \"tuningAlgorithm\": \"\",\n \"notificationOnCompletion\": \"\",\n \"tunerSpaceOptions\": \"\",\n \"space\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/config", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "config" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "state", "item": [ { "name": "Retrieves the EON tuner state", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/state", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "state" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieves the EON tuner state" }, "response": [ { "name": "Current EON tuner state", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/state", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "state" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"config\": {\n \"value\": \"\"\n },\n \"status\": {\n \"value\": \"\"\n },\n \"trials\": {\n \"value\": \"\"\n },\n \"workers\": {\n \"value\": \"\"\n },\n \"activeTunerJobId\": {\n \"value\": \"\"\n },\n \"projectDataType\": {\n \"value\": \"\"\n },\n \"jobError\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Delete EON tuner state", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/state", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "state" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Completely clears the EON tuner state for this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/state", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "state" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get window settings", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/window-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "window-settings" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get window settings" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/window-settings", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "window-settings" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"windowSettings\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Score trial", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"experiment\": \"\",\n \"original_trial_id\": \"\",\n \"inputBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"learnBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/score-trial", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "score-trial" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Score trial" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"experiment\": \"\",\n \"original_trial_id\": \"\",\n \"inputBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"learnBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/score-trial", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "score-trial" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"latency\": {\n \"value\": \"\"\n },\n \"ram\": {\n \"value\": \"\"\n },\n \"rom\": {\n \"value\": \"\"\n },\n \"score\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create trial", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"experiment\": \"\",\n \"original_trial_id\": \"\",\n \"inputBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"learnBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/:jobId/create-trial", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", ":jobId", "create-trial" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Create trial" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\",\n \"experiment\": \"\",\n \"original_trial_id\": \"\",\n \"inputBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"learnBlocks\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/:jobId/create-trial", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", ":jobId", "create-trial" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Search space", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/space", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "space" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Search space" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/space", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "space" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"impulse\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Retrieves DSP block parameters", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/dsp-parameters?organizationId=&organizationDspId=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "dsp-parameters" ], "query": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "organizationDspId", "value": "", "description": "(Required) Organization DSP ID" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieves DSP block parameters" }, "response": [ { "name": "DSP parameters", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/dsp-parameters?organizationId=&organizationDspId=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "dsp-parameters" ], "query": [ { "key": "organizationId", "value": "" }, { "key": "organizationDspId", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parameters\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Retrieves available transfer learning models", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/transfer-learning-models", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "transfer-learning-models" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieves available transfer learning models" }, "response": [ { "name": "Block info", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/transfer-learning-models", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "transfer-learning-models" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"models\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get trial logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/trial/:trialId/stdout?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "trial", ":trialId", "stdout" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "logLevel", "value": "", "description": "Log level (error, warn, info, debug)" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "trialId", "value": "", "description": "(Required) trial ID" } ] }, "description": "Get the logs for a trial." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/optimize/trial/:trialId/stdout?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "optimize", "trial", ":trialId", "stdout" ], "query": [ { "key": "limit", "value": "" }, { "key": "logLevel", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "trialId", "value": "", "description": "(Required) trial ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"stdout\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "notes", "item": [ { "name": "{noteId}", "item": [ { "name": "Update note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/notes/:noteId/update", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes", ":noteId", "update" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "noteId", "value": "", "description": "(Required) Note ID" } ] }, "description": "Update a note from a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/notes/:noteId/update", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes", ":noteId", "update" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "noteId", "value": "", "description": "(Required) Note ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Remove note", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/notes/:noteId/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes", ":noteId", "remove" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "noteId", "value": "", "description": "(Required) Note ID" } ] }, "description": "Remove a note from a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/notes/:noteId/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes", ":noteId", "remove" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "noteId", "value": "", "description": "(Required) Note ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get notes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get all notes in project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/notes", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"notes\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add note", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/notes/add", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes", "add" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Add a note to a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"note\": \"\",\n \"parentId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/notes/add", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "notes", "add" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Project information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "List all information about this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"project\": {\n \"value\": \"\"\n },\n \"developmentKeys\": {\n \"value\": \"\"\n },\n \"impulse\": {\n \"value\": \"\"\n },\n \"devices\": {\n \"value\": \"\"\n },\n \"dataSummary\": {\n \"value\": \"\"\n },\n \"dataSummaryFiltered\": {\n \"value\": \"\"\n },\n \"dataSummaryPerCategory\": {\n \"value\": \"\"\n },\n \"computeTime\": {\n \"value\": \"\"\n },\n \"acquisitionSettings\": {\n \"value\": \"\"\n },\n \"collaborators\": {\n \"value\": \"\"\n },\n \"deploySettings\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"latencyDevices\": {\n \"value\": \"\"\n },\n \"urls\": {\n \"value\": \"\"\n },\n \"showCreateFirstImpulse\": {\n \"value\": \"\"\n },\n \"showProjectTypeWizard\": {\n \"value\": \"\"\n },\n \"showGettingStartedWizard\": {\n \"value\": \"\"\n },\n \"performance\": {\n \"value\": \"\"\n },\n \"trainJobNotificationUids\": {\n \"value\": \"\"\n },\n \"dspJobNotificationUids\": {\n \"value\": \"\"\n },\n \"modelTestingJobNotificationUids\": {\n \"value\": \"\"\n },\n \"exportJobNotificationUids\": {\n \"value\": \"\"\n },\n \"hasNewTrainingData\": {\n \"value\": \"\"\n },\n \"readme\": {\n \"value\": \"\"\n },\n \"csvImportConfig\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"lastDeployEonCompiler\": \"\",\n \"latencyDevice\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"showCreateFirstImpulse\": \"\",\n \"labelingMethod\": \"\",\n \"showProjectTypeWizard\": \"\",\n \"selectedProjectTypeInWizard\": \"\",\n \"gettingStartedStep\": \"\",\n \"useGpu\": \"\",\n \"computeTimeLimitM\": \"\",\n \"dspFileSizeMb\": \"\",\n \"enterprisePerformance\": \"\",\n \"trainJobRamMb\": \"\",\n \"metadata\": \"\",\n \"readme\": \"\",\n \"lastAcquisitionLabel\": \"\",\n \"trainJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelTestingJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exportJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"csvImportConfig\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Update project properties such as name and logo." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"lastDeployEonCompiler\": \"\",\n \"latencyDevice\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"showCreateFirstImpulse\": \"\",\n \"labelingMethod\": \"\",\n \"showProjectTypeWizard\": \"\",\n \"selectedProjectTypeInWizard\": \"\",\n \"gettingStartedStep\": \"\",\n \"useGpu\": \"\",\n \"computeTimeLimitM\": \"\",\n \"dspFileSizeMb\": \"\",\n \"enterprisePerformance\": \"\",\n \"trainJobRamMb\": \"\",\n \"metadata\": \"\",\n \"readme\": \"\",\n \"lastAcquisitionLabel\": \"\",\n \"trainJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelTestingJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exportJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"csvImportConfig\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove project", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Remove the current project, and all data associated with it. This is irrevocable!" }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Give access to project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "body": { "mode": "formdata", "formdata": [ { "key": "nextUrl", "value": "", "type": "text", "description": "(Required) The URL to redirect to after authorization is completed." } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/third-party-auth/:authId/authorize", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "third-party-auth", ":authId", "authorize" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] }, "description": "Authorize a third party to access a project" }, "response": [ { "name": "A redirect to the nextUrl from the request", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) The URL to redirect to after authorization is completed.", "key": "nextUrl", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/third-party-auth/:authId/authorize", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "third-party-auth", ":authId", "authorize" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "authId", "value": "", "description": "(Required) Auth ID" } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Get development keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/devkeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devkeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve the development API and HMAC keys for a project. These keys are specifically marked to be used during development. These keys can be `undefined` if no development keys are set." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/devkeys", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "devkeys" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Get downloads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/downloads", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "downloads" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Retrieve the downloads for a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/downloads", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "downloads" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"downloads\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List emails", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/emails", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "emails" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get a list of all emails sent by Edge Impulse regarding this project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/emails", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "emails" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"emails\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get socket token", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/socket-token", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "socket-token" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get a token to authenticate with the web socket interface." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/socket-token", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "socket-token" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get data axes summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/data-axes?includeDisabled=&includeNotProcessed=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "data-axes" ], "query": [ { "key": "includeDisabled", "value": "", "description": "Whether to include disabled samples. Defaults to true" }, { "key": "includeNotProcessed", "value": "", "description": "Whether to include non-processed samples. Defaults to true" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get a list of axes that are present in the training data." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/data-axes?includeDisabled=&includeNotProcessed=", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "data-axes" ], "query": [ { "key": "includeDisabled", "value": "" }, { "key": "includeNotProcessed", "value": "" } ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"dataAxisSummary\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get the interval (in ms) of the training data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/data-interval", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "data-interval" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get the interval of the training data; if multiple intervals are present, the interval of the longest data item is returned." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/data-interval", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "data-interval" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"intervalMs\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Set compute time limit", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"jobLimitM\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/compute-time-limit", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "compute-time-limit" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Change the job compute time limit for the project. This function is only available through a JWT token, and is not available to all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"jobLimitM\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/compute-time-limit", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "compute-time-limit" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Set DSP file size limit", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dspFileSizeMb\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp-file-size-limit", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp-file-size-limit" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Change the DSP file size limit for the project. This function is only available through a JWT token, and is not available to all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dspFileSizeMb\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/dsp-file-size-limit", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "dsp-file-size-limit" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Upload image for readme", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "type": "file", "description": "(Required) ", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/readme/upload-image", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "readme", "upload-image" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Uploads an image to the user CDN and returns the path." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/:projectId/readme/upload-image", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "readme", "upload-image" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Launch getting started wizard", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/launch-getting-started", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "launch-getting-started" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "This clears out *all data in your project*, and is irrevocable. This function is only available through a JWT token, and is not available to all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/launch-getting-started", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "launch-getting-started" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Last modification", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/last-modification", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "last-modification" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get the last modification date for a project (will be upped when data is modified, or when an impulse is trained)" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/last-modification", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "last-modification" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"lastModificationDate\": {\n \"value\": \"\"\n },\n \"lastVersionDate\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update tags", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "tags" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Update the list of project tags." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/tags", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "tags" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Rebalance dataset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/rebalance", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "rebalance" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Rebalances the dataset over training / testing categories. This resets the category for all data and splits it 80%/20% between training and testing. This is a deterministic process based on the hash of the name of the data." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/rebalance", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "rebalance" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Verify custom DSP block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/verify-dsp-block/url", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "verify-dsp-block", "url" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Verify the validity of a custom DSP block" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/:projectId/verify-dsp-block/url", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "verify-dsp-block", "url" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"block\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Download trained model", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/learn-data/:learnId/model/:modelDownloadId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "learn-data", ":learnId", "model", ":modelDownloadId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" }, { "key": "modelDownloadId", "value": "", "description": "(Required) Model download ID, which can be obtained from the project information" } ] }, "description": "Download a trained model for a learning block. Depending on the block this can be a TensorFlow model, or the cluster centroids." }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/learn-data/:learnId/model/:modelDownloadId", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "learn-data", ":learnId", "model", ":modelDownloadId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "learnId", "value": "", "description": "(Required) Learn Block ID, use the impulse functions to retrieve the ID" }, { "key": "modelDownloadId", "value": "", "description": "(Required) Model download ID, which can be obtained from the project information" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] }, { "name": "Get URL of export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/export/get-url", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "export", "get-url" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Get the URL to the exported artefacts for an export job of a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/:projectId/export/get-url", "host": [ "{{baseUrl}}" ], "path": [ "api", ":projectId", "export", "get-url" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"hasExport\": {\n \"value\": \"\"\n },\n \"created\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "themes", "item": [ { "name": "{themeId}", "item": [ { "name": "Get theme by ID", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/themes/:themeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] }, "description": "Get a theme given its unique identifier." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/themes/:themeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"theme\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Delete theme by ID", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/themes/:themeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] }, "description": "Delete a theme given its unique identifier." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/themes/:themeId", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Update theme logos", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"primary\": \"\",\n \"primaryWhite\": \"\",\n \"login\": \"\",\n \"loginWhite\": \"\",\n \"mark\": \"\",\n \"markWhite\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/themes/:themeId/logos", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId", "logos" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] }, "description": "Update some or all theme logos." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"primary\": \"\",\n \"primaryWhite\": \"\",\n \"login\": \"\",\n \"loginWhite\": \"\",\n \"mark\": \"\",\n \"markWhite\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/themes/:themeId/logos", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId", "logos" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Update theme colors", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"primaryColor\": \"\",\n \"primaryColorGradientEnd\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/themes/:themeId/colors", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId", "colors" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] }, "description": "Update some or all theme colors." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"primaryColor\": \"\",\n \"primaryColorGradientEnd\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/themes/:themeId/colors", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId", "colors" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Update theme favicon", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "", "type": "text", "description": "(Required) " } ] }, "url": { "raw": "{{baseUrl}}/api/themes/:themeId/favicon", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId", "favicon" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] }, "description": "Update the theme favicon" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/themes/:themeId/favicon", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes", ":themeId", "favicon" ], "variable": [ { "key": "themeId", "value": "", "description": "(Required) Theme ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get themes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/themes", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes" ] }, "description": "Get all available Studio themes." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/themes", "host": [ "{{baseUrl}}" ], "path": [ "api", "themes" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"themes\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "whitelabels", "item": [ { "name": "List the registered white labels", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/whitelabels", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabels" ] }, "description": "Retrieve the list of registered white labels." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/whitelabels", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabels" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"whitelabels\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create a new white label", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"domain\": \"\",\n \"ownerOrganizationId\": \"\",\n \"identityProviders\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowPasswordAuth\": \"\",\n \"deploymentTargets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"documentationUrl\": \"\",\n \"allowSignup\": \"\",\n \"allowFreeProjects\": \"\",\n \"sandboxed\": \"\",\n \"exposePublicProjects\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/whitelabels", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabels" ] }, "description": "Create a new white label" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"domain\": \"\",\n \"ownerOrganizationId\": \"\",\n \"identityProviders\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"allowPasswordAuth\": \"\",\n \"deploymentTargets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"documentationUrl\": \"\",\n \"allowSignup\": \"\",\n \"allowFreeProjects\": \"\",\n \"sandboxed\": \"\",\n \"exposePublicProjects\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/whitelabels", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabels" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"themeId\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "whitelabel/{whitelabelIdentifier}", "item": [ { "name": "White label information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] }, "description": "Retrieve all the information about this white label." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"whitelabel\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Deletes a white label", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] }, "description": "Deletes the white label with the given id." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get white label domain", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier/domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier", "domain" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] }, "description": "Get a white label domain given its unique identifier." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier/domain", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier", "domain" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"domain\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update deployment targets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier/deploymentTargets", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier", "deploymentTargets" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] }, "description": "Update some or all of the deployment targets enabled for this white label." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"targets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier/deploymentTargets", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier", "deploymentTargets" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get impulse blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier/impulse/blocks", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier", "impulse", "blocks" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] }, "description": "Lists all possible DSP and ML blocks available for this white label." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/whitelabel/:whitelabelIdentifier/impulse/blocks", "host": [ "{{baseUrl}}" ], "path": [ "api", "whitelabel", ":whitelabelIdentifier", "impulse", "blocks" ], "variable": [ { "key": "whitelabelIdentifier", "value": "", "description": "(Required) Whitelabel ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"inputBlocks\": {\n \"value\": \"\"\n },\n \"dspBlocks\": {\n \"value\": \"\"\n },\n \"learnBlocks\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "projects", "item": [ { "name": "List active projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "projects" ] }, "description": "Retrieve list of active projects. If authenticating using JWT token this lists all the projects the user has access to, if authenticating using an API key, this only lists that project." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "projects" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] }, { "name": "Create new project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectName\": \"\",\n \"originalProjectVersionId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/projects/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "projects", "create" ] }, "description": "Create a new project. This API can only be called using a JWT token." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"projectName\": \"\",\n \"originalProjectVersionId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/projects/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "projects", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List public projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/projects/public?limit=&offset=&project=", "host": [ "{{baseUrl}}" ], "path": [ "api", "projects", "public" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." }, { "key": "project", "value": "", "description": "Only include projects that contain this string" } ] }, "description": "Retrieve the list of all public projects. You don't need any authentication for this method." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/projects/public?limit=&offset=&project=", "host": [ "{{baseUrl}}" ], "path": [ "api", "projects", "public" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "project", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "auth", "item": [ { "name": "Discourse", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/auth/discourse?sso=&sig=", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "discourse" ], "query": [ { "key": "sso", "value": "", "description": "(Required) Single sign-on token" }, { "key": "sig", "value": "", "description": "(Required) Verification signature" } ] }, "description": "Log in a user to the forum. This function is only available through a JWT token." }, "response": [ { "name": "Discourse SSO link", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/auth/discourse?sso=&sig=", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "discourse" ], "query": [ { "key": "sso", "value": "" }, { "key": "sig", "value": "" } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] }, { "name": "Readme.io", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/auth/readme", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "readme" ] }, "description": "Log in a user to the docs. This function is only available through a JWT token." }, "response": [ { "name": "Readme.io SSO link", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/auth/readme", "host": [ "{{baseUrl}}" ], "path": [ "api", "auth", "readme" ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "whitelabel", "item": [ { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "Get a white label user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users", ":userId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "White label admin only API to get information about a user." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users", ":userId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"user\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update white label user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users", ":userId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "White label admin only API to update user properties." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users", ":userId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get white label user metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users/:userId/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users", ":userId", "metrics" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "White label admin only API to get marketing metrics about a user." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users/:userId/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users", ":userId", "metrics" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"metrics\": {\n \"value\": \"\"\n },\n \"labels\": -21194993,\n \"classificationType\": \"Ut consequat exercitation voluptate\"\n}" } ] } ] }, { "name": "Get all white label users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users?user=&active=&tier=&fields=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users" ], "query": [ { "key": "user", "value": "", "description": "Part of e-mail address or username" }, { "key": "active", "value": "", "description": "Whether to search for entities (users, orgs) active in the last X days" }, { "key": "tier", "value": "", "description": "Whether to search for free, pro or enterprise entities (users, projects)" }, { "key": "fields", "value": "", "description": "Comma separated list of fields to fetch in a query" }, { "key": "sort", "value": "", "description": "Fields and order to sort query by" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "White label admin only API to get the list of all registered users." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/users?user=&active=&tier=&fields=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "users" ], "query": [ { "key": "user", "value": "" }, { "key": "active", "value": "" }, { "key": "tier", "value": "" }, { "key": "fields", "value": "" }, { "key": "sort", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"users\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "projects", "item": [ { "name": "{projectId}", "item": [ { "name": "Get a white label project", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "projects", ":projectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "White label admin only API to get project information." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "projects", ":projectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"project\": {\n \"value\": \"\"\n },\n \"developmentKeys\": {\n \"value\": \"\"\n },\n \"impulse\": {\n \"value\": \"\"\n },\n \"devices\": {\n \"value\": \"\"\n },\n \"dataSummary\": {\n \"value\": \"\"\n },\n \"dataSummaryFiltered\": {\n \"value\": \"\"\n },\n \"dataSummaryPerCategory\": {\n \"value\": \"\"\n },\n \"computeTime\": {\n \"value\": \"\"\n },\n \"acquisitionSettings\": {\n \"value\": \"\"\n },\n \"collaborators\": {\n \"value\": \"\"\n },\n \"deploySettings\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"latencyDevices\": {\n \"value\": \"\"\n },\n \"urls\": {\n \"value\": \"\"\n },\n \"showCreateFirstImpulse\": {\n \"value\": \"\"\n },\n \"showProjectTypeWizard\": {\n \"value\": \"\"\n },\n \"showGettingStartedWizard\": {\n \"value\": \"\"\n },\n \"performance\": {\n \"value\": \"\"\n },\n \"trainJobNotificationUids\": {\n \"value\": \"\"\n },\n \"dspJobNotificationUids\": {\n \"value\": \"\"\n },\n \"modelTestingJobNotificationUids\": {\n \"value\": \"\"\n },\n \"exportJobNotificationUids\": {\n \"value\": \"\"\n },\n \"hasNewTrainingData\": {\n \"value\": \"\"\n },\n \"readme\": {\n \"value\": \"\"\n },\n \"csvImportConfig\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update white label project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"lastDeployEonCompiler\": \"\",\n \"latencyDevice\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"showCreateFirstImpulse\": \"\",\n \"labelingMethod\": \"\",\n \"showProjectTypeWizard\": \"\",\n \"selectedProjectTypeInWizard\": \"\",\n \"gettingStartedStep\": \"\",\n \"useGpu\": \"\",\n \"computeTimeLimitM\": \"\",\n \"dspFileSizeMb\": \"\",\n \"enterprisePerformance\": \"\",\n \"trainJobRamMb\": \"\",\n \"metadata\": \"\",\n \"readme\": \"\",\n \"lastAcquisitionLabel\": \"\",\n \"trainJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelTestingJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exportJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"csvImportConfig\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "projects", ":projectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "White label admin only API to update project properties." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"lastDeployEonCompiler\": \"\",\n \"latencyDevice\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"showCreateFirstImpulse\": \"\",\n \"labelingMethod\": \"\",\n \"showProjectTypeWizard\": \"\",\n \"selectedProjectTypeInWizard\": \"\",\n \"gettingStartedStep\": \"\",\n \"useGpu\": \"\",\n \"computeTimeLimitM\": \"\",\n \"dspFileSizeMb\": \"\",\n \"enterprisePerformance\": \"\",\n \"trainJobRamMb\": \"\",\n \"metadata\": \"\",\n \"readme\": \"\",\n \"lastAcquisitionLabel\": \"\",\n \"trainJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelTestingJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exportJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"csvImportConfig\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "projects", ":projectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get all white label projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/projects?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "projects" ], "query": [ { "key": "name", "value": "", "description": "Part of an entity name (could be a project, an org...)" }, { "key": "active", "value": "", "description": "Whether to search for entities (users, orgs) active in the last X days" }, { "key": "sort", "value": "", "description": "Fields and order to sort query by" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "White label admin only API to get the list of all projects." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/projects?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "projects" ], "query": [ { "key": "name", "value": "" }, { "key": "active", "value": "" }, { "key": "sort", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "organizations", "item": [ { "name": "{innerOrganizationId}", "item": [ { "name": "Get organization information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations/:innerOrganizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations", ":innerOrganizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "innerOrganizationId", "value": "", "description": "(Required) Organization ID within the context of a white label" } ] }, "description": "White label admin only API to list all information about an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations/:innerOrganizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations", ":innerOrganizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "innerOrganizationId", "value": "", "description": "(Required) Organization ID within the context of a white label" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"billable\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update organization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"headerImg\": \"\",\n \"name\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"readme\": \"\",\n \"billable\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations/:innerOrganizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations", ":innerOrganizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "innerOrganizationId", "value": "", "description": "(Required) Organization ID within the context of a white label" } ] }, "description": "White label admin only API to update organization properties such as name and logo." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"headerImg\": \"\",\n \"name\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"readme\": \"\",\n \"billable\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations/:innerOrganizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations", ":innerOrganizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "innerOrganizationId", "value": "", "description": "(Required) Organization ID within the context of a white label" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get all organizations within a white label", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations" ], "query": [ { "key": "name", "value": "", "description": "Part of an entity name (could be a project, an org...)" }, { "key": "active", "value": "", "description": "Whether to search for entities (users, orgs) active in the last X days" }, { "key": "sort", "value": "", "description": "Fields and order to sort query by" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "White label admin only API to get the list of all organizations." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations" ], "query": [ { "key": "name", "value": "" }, { "key": "active", "value": "" }, { "key": "sort", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organizations\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create new organization within white label context", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"\",\n \"adminId\": \"\",\n \"adminEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Create a new organization. This is an internal API only available to white label admins" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"\",\n \"adminId\": \"\",\n \"adminEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "organizations" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Get global white label metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "metrics" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "White label admin only API to get global metrics." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/whitelabel/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "whitelabel", "metrics" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"metrics\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "apikeys", "item": [ { "name": "Get API keys", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "apikeys" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all API keys. This does **not** return the full API key, but only a portion (for security purposes)." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "apikeys" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"apiKeys\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add API key", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "apikeys" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Add an API key." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"apiKey\": \"\",\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/apikeys", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "apikeys" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Revoke API key", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "apiKeyId", "value": "", "description": "(Required) API key ID" } ] }, "description": "Revoke an API key." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/apikeys/:apiKeyId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "apikeys", ":apiKeyId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "apiKeyId", "value": "", "description": "(Required) API key ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "members", "item": [ { "name": "{memberId}", "item": [ { "name": "Set member role", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/:memberId/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", ":memberId", "role" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "memberId", "value": "", "description": "(Required) Member ID" } ] }, "description": "Change the role of a member in an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"role\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/:memberId/role", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", ":memberId", "role" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "memberId", "value": "", "description": "(Required) Member ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Set member datasets", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/:memberId/datasets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", ":memberId", "datasets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "memberId", "value": "", "description": "(Required) Member ID" } ] }, "description": "Set the datasets a guest member has access to in an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/:memberId/datasets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", ":memberId", "datasets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "memberId", "value": "", "description": "(Required) Member ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Resend invitation", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/:memberId/resend-invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", ":memberId", "resend-invite" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "memberId", "value": "", "description": "(Required) Member ID" } ] }, "description": "Resend an invitation to a member in an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/:memberId/resend-invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", ":memberId", "resend-invite" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "memberId", "value": "", "description": "(Required) Member ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Add member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\",\n \"role\": \"\",\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", "add" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Add a member to an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"usernameOrEmail\": \"\",\n \"role\": \"\",\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", "add" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Invite member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"role\": \"\",\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", "invite" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Invite a member to an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"role\": \"\",\n \"datasets\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/invite", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", "invite" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove member", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", "remove" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Remove a member from an organization. Note that you cannot invoke this function if only a single member is present to the organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"id\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/members/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "members", "remove" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "buckets", "item": [ { "name": "{bucketId}", "item": [ { "name": "Update storage bucket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accessKey\": \"\",\n \"secretKey\": \"\",\n \"endpoint\": \"\",\n \"bucket\": \"\",\n \"prefix\": \"\",\n \"region\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets/:bucketId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets", ":bucketId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "bucketId", "value": "", "description": "(Required) Bucket ID" } ] }, "description": "Updates storage bucket details. This only updates fields that were set in the request body." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accessKey\": \"\",\n \"secretKey\": \"\",\n \"endpoint\": \"\",\n \"bucket\": \"\",\n \"prefix\": \"\",\n \"region\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets/:bucketId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets", ":bucketId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "bucketId", "value": "", "description": "(Required) Bucket ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove storage bucket", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets/:bucketId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets", ":bucketId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "bucketId", "value": "", "description": "(Required) Bucket ID" } ] }, "description": "Remove a storage bucket. This will render any data in this storage bucket unreachable." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets/:bucketId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets", ":bucketId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "bucketId", "value": "", "description": "(Required) Bucket ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "List storage buckets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all configured storage buckets. This does not list the secret key." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"buckets\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add a storage bucket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accessKey\": \"\",\n \"secretKey\": \"\",\n \"endpoint\": \"\",\n \"bucket\": \"\",\n \"region\": \"\",\n \"prefix\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Add a storage bucket." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"accessKey\": \"\",\n \"secretKey\": \"\",\n \"endpoint\": \"\",\n \"bucket\": \"\",\n \"region\": \"\",\n \"prefix\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Verify bucket connectivity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\",\n \"secretKey\": \"\",\n \"endpoint\": \"\",\n \"bucket\": \"\",\n \"region\": \"\",\n \"prefix\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets", "verify" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Verify whether we can reach a bucket before adding it." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"accessKey\": \"\",\n \"secretKey\": \"\",\n \"endpoint\": \"\",\n \"bucket\": \"\",\n \"region\": \"\",\n \"prefix\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/buckets/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "buckets", "verify" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"files\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "data", "item": [ { "name": "{dataId}", "item": [ { "name": "download", "item": [ { "name": "Download data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/zip" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/download?filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "download" ], "query": [ { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Download all data for this data item." }, "response": [ { "name": "ZIP file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/download?filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "download" ], "query": [ { "key": "filter", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/zip" } ], "cookie": [], "body": "" } ] }, { "name": "Delete file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/download?fileName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "download" ], "query": [ { "key": "fileName", "value": "", "description": "(Required) File name" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Delete a single file from a data item." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/download?fileName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "download" ], "query": [ { "key": "fileName", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "files", "item": [ { "name": "Download file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/files/download?fileName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "files", "download" ], "query": [ { "key": "fileName", "value": "", "description": "(Required) File name" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Download a single file from a data item." }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/files/download?fileName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "files", "download" ], "query": [ { "key": "fileName", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] }, { "name": "Preview file", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/files/preview?fileName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "files", "preview" ], "query": [ { "key": "fileName", "value": "", "description": "(Required) File name" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline)." }, "response": [ { "name": "File", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/files/preview?fileName=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "files", "preview" ], "query": [ { "key": "fileName", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Get data metadata", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId?filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId" ], "query": [ { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Get a data item. This will HEAD the underlying bucket to retrieve the last file information." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId?filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId" ], "query": [ { "key": "filter", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"data\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update data metadata", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dataset\": \"\",\n \"metadata\": {\n \"deserunt0a\": {\n \"value\": \"\"\n },\n \"et_ba1\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Update the data item metadata." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dataset\": \"\",\n \"metadata\": {\n \"deserunt0a\": {\n \"value\": \"\"\n },\n \"et_ba1\": {\n \"value\": \"\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete data", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Delete a data item. This does not remove the items from the underlying storage." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Add files", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "files[]", "value": "[{\"value\":\"\"},{\"value\":\"\"}]", "type": "text", "description": "(Required) " } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "add" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] }, "description": "Add a new file to an existing data item. Don't trust the code generated by the widget, there are examples of using this API in Python, cURL and Node.js under the parameters." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "files[]", "value": "[\"\",\"\"]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/:dataId/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", ":dataId", "add" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataId", "value": "", "description": "(Required) Data ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "List data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data?dataset=&filter=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" }, { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Lists all data items. This can be filtered by the ?filter parameter." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data?dataset=&filter=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data" ], "query": [ { "key": "dataset", "value": "" }, { "key": "filter", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"filterParseError\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"totalFileCount\": {\n \"value\": \"\"\n },\n \"totalDataItemCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add new data", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "(Required) " }, { "key": "dataset", "value": "", "type": "text", "description": "(Required) " }, { "key": "metadata", "value": "", "type": "text", "description": "(Required) Key-value pair of metadata (in JSON format)" }, { "key": "files[]", "value": "[{\"value\":\"\"},{\"value\":\"\"}]", "type": "text", "description": "(Required) " }, { "key": "bucketId", "value": "", "type": "text" }, { "key": "bucketName", "value": "", "type": "text", "description": "Name of the bucket name (as an Edge Impulse name)" }, { "key": "bucketPath", "value": "", "type": "text", "description": "Optional path in the bucket to create this data item (files are created under this path)." } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "add" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Add a new data item. You can add a maximum of 10000 files directly through this API. Use `addOrganizationDataFile` to add additional files. Don't trust the code generated by the widget, there are examples of using this API in Python, cURL and Node.js under the parameters." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "name", "value": "", "type": "text" }, { "description": "(Required) ", "key": "dataset", "value": "", "type": "text" }, { "description": "(Required) Key-value pair of metadata (in JSON format)", "key": "metadata", "value": "", "type": "text" }, { "description": "(Required) ", "key": "files[]", "value": "[\"\",\"\"]", "type": "text" }, { "key": "bucketId", "value": "", "type": "text" }, { "description": "Name of the bucket name (as an Edge Impulse name)", "key": "bucketName", "value": "", "type": "text" }, { "description": "Optional path in the bucket to create this data item (files are created under this path).", "key": "bucketPath", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "add" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Add data items from bucket", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dataset\": \"\",\n \"bucketId\": \"\",\n \"bucketPath\": \"\",\n \"metadataDataset\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/add-folder", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "add-folder" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Bulk adds data items that already exist in a storage bucket. The bucket path specified should contain folders. Each folder is added as a data item in Edge Impulse." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset\": \"\",\n \"bucketId\": \"\",\n \"bucketPath\": \"\",\n \"metadataDataset\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/add-folder", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "add-folder" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Download data", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/x-tar" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/download?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "download" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" }, { "key": "dataIds", "value": "", "description": "(Required) Data IDs as an Array" }, { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Download all data for selected data items. This function does not query the underlying bucket." }, "response": [ { "name": "TAR file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/download?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "download" ], "query": [ { "key": "dataset", "value": "" }, { "key": "dataIds", "value": "" }, { "key": "filter", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/x-tar" } ], "cookie": [], "body": "" } ] }, { "name": "Delete data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/delete?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "delete" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" }, { "key": "dataIds", "value": "", "description": "(Required) Data IDs as an Array" }, { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Delete all data for selected data items. This removes all data in the underlying data bucket." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/delete?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "delete" ], "query": [ { "key": "dataset", "value": "" }, { "key": "dataIds", "value": "" }, { "key": "filter", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Clear checklist for data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/clear-checklist?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "clear-checklist" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" }, { "key": "dataIds", "value": "", "description": "(Required) Data IDs as an Array" }, { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Clear all checklist flags for selected data items." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/clear-checklist?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "clear-checklist" ], "query": [ { "key": "dataset", "value": "" }, { "key": "dataIds", "value": "" }, { "key": "filter", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Change dataset", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dataset\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/change-dataset?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "change-dataset" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" }, { "key": "dataIds", "value": "", "description": "(Required) Data IDs as an Array" }, { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Change the dataset for selected data items." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"dataset\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/change-dataset?dataset=&dataIds=&filter=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "change-dataset" ], "query": [ { "key": "dataset", "value": "" }, { "key": "dataIds", "value": "" }, { "key": "filter", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List files", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/files?dataset=&filter=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "files" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" }, { "key": "filter", "value": "", "description": "Data filter in SQL WHERE format, where you can reference 'dataset', 'bucket', 'name', 'total_file_count', 'total_file_size', 'created' and any metadata label through 'metadata->' (dots are replaced by underscore)." }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Lists all files included by the filter." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/files?dataset=&filter=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "files" ], "query": [ { "key": "dataset", "value": "" }, { "key": "filter", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"totalFileSize\": {\n \"value\": \"\"\n },\n \"totalFileCount\": {\n \"value\": \"\"\n },\n \"totalDataItemCount\": {\n \"value\": \"\"\n },\n \"data\": {\n \"value\": \"\"\n },\n \"filterParseError\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Refresh data", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/refresh?dataset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "refresh" ], "query": [ { "key": "dataset", "value": "", "description": "Selected dataset" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/refresh?dataset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "refresh" ], "query": [ { "key": "dataset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Bulk update metadata", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "dataset", "value": "", "type": "text", "description": "(Required) " }, { "key": "csvFile", "type": "file", "description": "(Required) ", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/bulk-metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "bulk-metadata" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Bulk update the metadata of many data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named 'name'. The other columns are used as metadata keys." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "dataset", "value": "", "type": "text" }, { "description": "(Required) ", "key": "csvFile", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/data/bulk-metadata", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "data", "bulk-metadata" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "dataset/{dataset}", "item": [ { "name": "Get dataset", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dataset/:dataset", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dataset", ":dataset" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataset", "value": "", "description": "(Required) Dataset name" } ] }, "description": "Get information about a dataset" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dataset/:dataset", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dataset", ":dataset" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataset", "value": "", "description": "(Required) Dataset name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"dataset\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update dataset", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"category\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dataset/:dataset", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dataset", ":dataset" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataset", "value": "", "description": "(Required) Dataset name" } ] }, "description": "Set information about a dataset" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"category\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dataset/:dataset", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dataset", ":dataset" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataset", "value": "", "description": "(Required) Dataset name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Hide dataset", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dataset/:dataset/hide", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dataset", ":dataset", "hide" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataset", "value": "", "description": "(Required) Dataset name" } ] }, "description": "Hide a dataset (does not remove underlying data)" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dataset/:dataset/hide", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dataset", ":dataset", "hide" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dataset", "value": "", "description": "(Required) Dataset name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "create-project", "item": [ { "name": "{createProjectId}", "item": [ { "name": "transform", "item": [ { "name": "Retry failed transform jobs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/transform/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "transform", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] }, "description": "Retry all failed transform job from a transformation job. Only jobs that have failed will be retried." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/transform/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "transform", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Clear failed transform jobs", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/transform/clear", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "transform", "clear" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] }, "description": "Clear all failed transform job from a create project job. Only jobs that have failed will be cleared." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/transform/clear", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "transform", "clear" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "files/{createProjectFileId}", "item": [ { "name": "Delete create project file", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/files/:createProjectFileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "files", ":createProjectFileId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." }, { "key": "createProjectFileId", "value": "", "description": "(Required) Create project job file ID." } ] }, "description": "Remove a file from a create project job. Only files for which no jobs are running can be deleted." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/files/:createProjectFileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "files", ":createProjectFileId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." }, { "key": "createProjectFileId", "value": "", "description": "(Required) Create project job file ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Retry transformation file", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/files/:createProjectFileId/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "files", ":createProjectFileId", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." }, { "key": "createProjectFileId", "value": "", "description": "(Required) Create project job file ID." } ] }, "description": "Retry a transformation action on a file from a transformation job. Only files that have failed can be retried." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/files/:createProjectFileId/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "files", ":createProjectFileId", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." }, { "key": "createProjectFileId", "value": "", "description": "(Required) Create project job file ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get transformation job status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId?transformLimit=&transformOffset=&selection=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId" ], "query": [ { "key": "transformLimit", "value": "", "description": "(Required) Maximum number of results of transformation jobs" }, { "key": "transformOffset", "value": "", "description": "(Required) Offset in results of transformation jobs, can be used in conjunction with TransformLimitResultsParameter to implement paging." }, { "key": "selection", "value": "", "description": "Type of selected rows, either 'all', 'created', 'in-progress' or 'failed' (defaults to 'all')" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] }, "description": "Get the current status of a transformation job job." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId?transformLimit=&transformOffset=&selection=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId" ], "query": [ { "key": "transformLimit", "value": "" }, { "key": "transformOffset", "value": "" }, { "key": "selection", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update transformation job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"transformationParallel\": \"\",\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] }, "description": "Update the properties of a transformation job." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"transformationParallel\": \"\",\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete transformation job", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] }, "description": "Remove a transformation job. This will stop all running jobs." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Retry transformation upload job", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/upload/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "upload", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] }, "description": "Retry the upload job from a transformation job. Only jobs that have failed can be retried." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project/:createProjectId/upload/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project", ":createProjectId", "upload", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "createProjectId", "value": "", "description": "(Required) Create project job ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "List transformation jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Get list of transformation jobs." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project?limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project" ], "query": [ { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Start transformation job", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"filter\": \"\",\n \"uploadType\": \"\",\n \"projectId\": \"\",\n \"newProjectName\": \"\",\n \"projectApiKey\": \"\",\n \"projectHmacKey\": \"\",\n \"transformationBlockId\": \"\",\n \"builtinTransformationBlock\": \"\",\n \"category\": \"\",\n \"outputDatasetName\": \"\",\n \"label\": \"\",\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transformationParallel\": \"\",\n \"extraCliArguments\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Start a transformation job to fetch data from the organization and put it in a project, or transform into new data." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"filter\": \"\",\n \"uploadType\": \"\",\n \"projectId\": \"\",\n \"newProjectName\": \"\",\n \"projectApiKey\": \"\",\n \"projectHmacKey\": \"\",\n \"transformationBlockId\": \"\",\n \"builtinTransformationBlock\": \"\",\n \"category\": \"\",\n \"outputDatasetName\": \"\",\n \"label\": \"\",\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"transformationParallel\": \"\",\n \"extraCliArguments\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/create-project", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "create-project" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"createProjectId\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "transformation", "item": [ { "name": "{transformationId}", "item": [ { "name": "Update transformation block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"indMetadata\": \"\",\n \"description\": \"\",\n \"cliArguments\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\",\n \"additionalMountPoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"operatesOn\": \"\",\n \"allowExtraCliArguments\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation", ":transformationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transformationId", "value": "", "description": "(Required) Transformation block ID." } ] }, "description": "Updates a transformation block. Only values in the body will be updated." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"indMetadata\": \"\",\n \"description\": \"\",\n \"cliArguments\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\",\n \"additionalMountPoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"operatesOn\": \"\",\n \"allowExtraCliArguments\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation", ":transformationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transformationId", "value": "", "description": "(Required) Transformation block ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete transformation block", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation", ":transformationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transformationId", "value": "", "description": "(Required) Transformation block ID." } ] }, "description": "Deletes a transformation block." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation/:transformationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation", ":transformationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transformationId", "value": "", "description": "(Required) Transformation block ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get transformation blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all transformation blocks." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"transformationBlocks\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add transformation block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"indMetadata\": \"\",\n \"description\": \"\",\n \"cliArguments\": \"\",\n \"additionalMountPoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"operatesOn\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\",\n \"allowExtraCliArguments\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Adds a transformation block." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"indMetadata\": \"\",\n \"description\": \"\",\n \"cliArguments\": \"\",\n \"additionalMountPoints\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"operatesOn\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\",\n \"allowExtraCliArguments\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transformation", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transformation" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "deploy", "item": [ { "name": "{deployId}", "item": [ { "name": "Update deploy block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text" }, { "key": "dockerContainer", "value": "", "type": "text" }, { "key": "description", "value": "", "type": "text" }, { "key": "cliArguments", "value": "", "type": "text" }, { "key": "requestsCpu", "value": "", "type": "text" }, { "key": "requestsMemory", "value": "", "type": "text" }, { "key": "limitsCpu", "value": "", "type": "text" }, { "key": "limitsMemory", "value": "", "type": "text" }, { "key": "photo", "type": "file", "value": null }, { "key": "integrateUrl", "value": "", "type": "text" }, { "key": "privileged", "value": "", "type": "text" }, { "key": "mountLearnBlock", "value": "", "type": "text" }, { "key": "supportsEonCompiler", "value": "", "type": "text" }, { "key": "showOptimizations", "value": "", "type": "text" }, { "key": "category", "value": "", "type": "text", "description": " (This can only be one of library,firmware)" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy/:deployId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy", ":deployId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "deployId", "value": "", "description": "(Required) Deploy block ID." } ] }, "description": "Updates a deploy block. Only values in the body will be updated." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text" }, { "key": "dockerContainer", "value": "", "type": "text" }, { "key": "description", "value": "", "type": "text" }, { "key": "cliArguments", "value": "", "type": "text" }, { "key": "requestsCpu", "value": "", "type": "text" }, { "key": "requestsMemory", "value": "", "type": "text" }, { "key": "limitsCpu", "value": "", "type": "text" }, { "key": "limitsMemory", "value": "", "type": "text" }, { "key": "photo", "value": "", "type": "text" }, { "key": "integrateUrl", "value": "", "type": "text" }, { "key": "privileged", "value": "", "type": "text" }, { "key": "mountLearnBlock", "value": "", "type": "text" }, { "key": "supportsEonCompiler", "value": "", "type": "text" }, { "key": "showOptimizations", "value": "", "type": "text" }, { "description": " (This can only be one of library,firmware)", "key": "category", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy/:deployId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy", ":deployId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "deployId", "value": "", "description": "(Required) Deploy block ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete deploy block", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy/:deployId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy", ":deployId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "deployId", "value": "", "description": "(Required) Deploy block ID." } ] }, "description": "Deletes a deploy block." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy/:deployId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy", ":deployId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "deployId", "value": "", "description": "(Required) Deploy block ID." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get deploy blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all deploy blocks." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"deployBlocks\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add deploy block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "name", "value": "", "type": "text", "description": "(Required) " }, { "key": "dockerContainer", "value": "", "type": "text", "description": "(Required) " }, { "key": "description", "value": "", "type": "text", "description": "(Required) " }, { "key": "cliArguments", "value": "", "type": "text", "description": "(Required) " }, { "key": "requestsCpu", "value": "", "type": "text" }, { "key": "requestsMemory", "value": "", "type": "text" }, { "key": "limitsCpu", "value": "", "type": "text" }, { "key": "limitsMemory", "value": "", "type": "text" }, { "key": "photo", "type": "file", "value": null }, { "key": "integrateUrl", "value": "", "type": "text" }, { "key": "privileged", "value": "", "type": "text" }, { "key": "mountLearnBlock", "value": "", "type": "text" }, { "key": "supportsEonCompiler", "value": "", "type": "text" }, { "key": "showOptimizations", "value": "", "type": "text" }, { "key": "category", "value": "", "type": "text", "description": " (This can only be one of library,firmware)" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Adds a deploy block." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "name", "value": "", "type": "text" }, { "description": "(Required) ", "key": "dockerContainer", "value": "", "type": "text" }, { "description": "(Required) ", "key": "description", "value": "", "type": "text" }, { "description": "(Required) ", "key": "cliArguments", "value": "", "type": "text" }, { "key": "requestsCpu", "value": "", "type": "text" }, { "key": "requestsMemory", "value": "", "type": "text" }, { "key": "limitsCpu", "value": "", "type": "text" }, { "key": "limitsMemory", "value": "", "type": "text" }, { "key": "photo", "value": "", "type": "text" }, { "key": "integrateUrl", "value": "", "type": "text" }, { "key": "privileged", "value": "", "type": "text" }, { "key": "mountLearnBlock", "value": "", "type": "text" }, { "key": "supportsEonCompiler", "value": "", "type": "text" }, { "key": "showOptimizations", "value": "", "type": "text" }, { "description": " (This can only be one of library,firmware)", "key": "category", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/deploy", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "deploy" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "dsp", "item": [ { "name": "{dspId}", "item": [ { "name": "Update dsp block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\",\n \"port\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp", ":dspId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Updates a dsp block. Only values in the body will be updated." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\",\n \"port\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp", ":dspId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete dsp block", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp", ":dspId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Deletes a dsp block." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp/:dspId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp", ":dspId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Retry connection to dsp block", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp/:dspId/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp", ":dspId", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] }, "description": "Retry launch a dsp block." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp/:dspId/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp", ":dspId", "retry" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "dspId", "value": "", "description": "(Required) DSP Block ID, use the impulse functions to retrieve the ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get dsp blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all dsp blocks." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"dspBlocks\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add dsp block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"port\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Adds a dsp block." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"port\": \"\",\n \"requestsCpu\": \"\",\n \"requestsMemory\": \"\",\n \"limitsCpu\": \"\",\n \"limitsMemory\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/dsp", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "dsp" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "transfer-learning", "item": [ { "name": "{transferLearningId}", "item": [ { "name": "Update transfer learning block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"operatesOn\": \"\",\n \"objectDetectionLastLayer\": {\n \"value\": \"\"\n },\n \"implementationVersion\": \"\",\n \"isPublic\": \"\",\n \"isPublicForDevices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repositoryUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning/:transferLearningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning", ":transferLearningId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transferLearningId", "value": "", "description": "(Required) Transfer learning ID" } ] }, "description": "Updates a transfer learning block. Only values in the body will be updated." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"operatesOn\": \"\",\n \"objectDetectionLastLayer\": {\n \"value\": \"\"\n },\n \"implementationVersion\": \"\",\n \"isPublic\": \"\",\n \"isPublicForDevices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repositoryUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning/:transferLearningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning", ":transferLearningId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transferLearningId", "value": "", "description": "(Required) Transfer learning ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete transfer learning block", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning/:transferLearningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning", ":transferLearningId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transferLearningId", "value": "", "description": "(Required) Transfer learning ID" } ] }, "description": "Deletes a transfer learning block." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning/:transferLearningId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning", ":transferLearningId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "transferLearningId", "value": "", "description": "(Required) Transfer learning ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get transfer learning blocks", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all transfer learning blocks." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"transferLearningBlocks\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add transfer learning block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"operatesOn\": \"\",\n \"implementationVersion\": \"\",\n \"objectDetectionLastLayer\": {\n \"value\": \"\"\n },\n \"isPublic\": \"\",\n \"isPublicForDevices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repositoryUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Adds a transfer learning block." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"dockerContainer\": \"\",\n \"description\": \"\",\n \"operatesOn\": \"\",\n \"implementationVersion\": \"\",\n \"objectDetectionLastLayer\": {\n \"value\": \"\"\n },\n \"isPublic\": \"\",\n \"isPublicForDevices\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"repositoryUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/transfer-learning", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "transfer-learning" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "secrets", "item": [ { "name": "Get secrets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "secrets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all secrets." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "secrets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"secrets\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add secret", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "secrets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Adds a secret." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"secret\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/secrets", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "secrets" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Delete transfer learning block", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/secrets/:secretId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "secrets", ":secretId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "secretId", "value": "", "description": "(Required) Secret ID" } ] }, "description": "Deletes a transfer learning block." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/secrets/:secretId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "secrets", ":secretId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "secretId", "value": "", "description": "(Required) Secret ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "jobs", "item": [ { "name": "{jobId}", "item": [ { "name": "stdout", "item": [ { "name": "Get logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/stdout?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "stdout" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "logLevel", "value": "", "description": "Log level (error, warn, info, debug)" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Get the logs for a job." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/stdout?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "stdout" ], "query": [ { "key": "limit", "value": "" }, { "key": "logLevel", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"stdout\": {\n \"value\": \"\"\n },\n \"totalCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Download logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/plain" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/stdout/download?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "stdout", "download" ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "logLevel", "value": "", "description": "Log level (error, warn, info, debug)" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Download the logs for a job (as a text file)." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/stdout/download?limit=&logLevel=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "stdout", "download" ], "query": [ { "key": "limit", "value": "" }, { "key": "logLevel", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Cancel job", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/cancel?forceCancel=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "cancel" ], "query": [ { "key": "forceCancel", "value": "", "description": "If set to 'true', we won't wait for the job cluster to cancel the job, and will mark the job as finished." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Cancel a running job." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/cancel?forceCancel=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "cancel" ], "query": [ { "key": "forceCancel", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get job status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "status" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] }, "description": "Get the status for a job." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/:jobId/status", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", ":jobId", "status" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "jobId", "value": "", "description": "(Required) Job ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"job\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "List active jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs?rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs" ], "query": [ { "key": "rootOnly", "value": "", "description": "Whether to exclude jobs with a parent ID (so jobs started as part of another job)" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Get all active jobs for this organization" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs?rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs" ], "query": [ { "key": "rootOnly", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List finished jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/history?startDate=&endDate=&limit=&offset=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", "history" ], "query": [ { "key": "startDate", "value": "", "description": "Start date" }, { "key": "endDate", "value": "", "description": "End date" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." }, { "key": "rootOnly", "value": "", "description": "Whether to exclude jobs with a parent ID (so jobs started as part of another job)" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Get all finished jobs for this organization" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/history?startDate=&endDate=&limit=&offset=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", "history" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "rootOnly", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List all jobs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/all?startDate=&endDate=&limit=&offset=&excludePipelineTransformJobs=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", "all" ], "query": [ { "key": "startDate", "value": "", "description": "Start date" }, { "key": "endDate", "value": "", "description": "End date" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." }, { "key": "excludePipelineTransformJobs", "value": "", "description": "Whether to exclude pipeline / transformation jobs" }, { "key": "rootOnly", "value": "", "description": "Whether to exclude jobs with a parent ID (so jobs started as part of another job)" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Get all jobs for this organization" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/jobs/all?startDate=&endDate=&limit=&offset=&excludePipelineTransformJobs=&rootOnly=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "jobs", "all" ], "query": [ { "key": "startDate", "value": "" }, { "key": "endDate", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" }, { "key": "excludePipelineTransformJobs", "value": "" }, { "key": "rootOnly", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"jobs\": {\n \"value\": \"\"\n },\n \"totalJobCount\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "pipelines", "item": [ { "name": "{pipelineId}", "item": [ { "name": "Get pipeline", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] }, "description": "Retrieve an organizational pipelines" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"pipeline\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update pipeline", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"intervalStr\": \"\",\n \"steps\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"whenToEmail\": \"\",\n \"dataset\": \"\",\n \"projectId\": \"\",\n \"notificationWebhook\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] }, "description": "Update an organizational pipelines" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"intervalStr\": \"\",\n \"steps\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"whenToEmail\": \"\",\n \"dataset\": \"\",\n \"projectId\": \"\",\n \"notificationWebhook\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete pipeline", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] }, "description": "Delete an organizational pipelines" }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Run pipelines", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId/run?ignoreLastSuccessfulRun=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId", "run" ], "query": [ { "key": "ignoreLastSuccessfulRun", "value": "", "description": "If set then `EI_LAST_SUCCESSFUL_RUN` is not set. You can use this to re-run a pipeline from scratch." } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] }, "description": "Run an organizational pipeline" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/:pipelineId/run?ignoreLastSuccessfulRun=", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", ":pipelineId", "run" ], "query": [ { "key": "ignoreLastSuccessfulRun", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "pipelineId", "value": "", "description": "(Required) Pipeline ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"pipelineRun\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "List pipelines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all organizational pipelines" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"pipelines\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create pipeline", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"intervalStr\": \"\",\n \"steps\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"whenToEmail\": \"\",\n \"dataset\": \"\",\n \"projectId\": \"\",\n \"notificationWebhook\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Create an organizational pipelines" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"intervalStr\": \"\",\n \"steps\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"emailRecipientUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"whenToEmail\": \"\",\n \"dataset\": \"\",\n \"projectId\": \"\",\n \"notificationWebhook\": \"\",\n \"archived\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "List archived pipelines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/archived", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", "archived" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all archived organizational pipelines" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/pipelines/archived", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "pipelines", "archived" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"pipelines\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "portals", "item": [ { "name": "{portalId}", "item": [ { "name": "Retrieve upload portal information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Retrieve a single upload portals identified by ID." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"token\": {\n \"value\": \"\"\n },\n \"bucketName\": {\n \"value\": \"\"\n },\n \"bucketPath\": {\n \"value\": \"\"\n },\n \"description\": {\n \"value\": \"\"\n },\n \"bucketId\": {\n \"value\": \"\"\n },\n \"bucketUrl\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Verify upload portal information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "verify" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Retrieve a subset of files from the portal, to be used in the data source wizard." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/verify", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "verify" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"files\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update upload portal", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bucketId\": \"\",\n \"bucketPath\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "update" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Updates an upload portal for the organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "PUT", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bucketId\": \"\",\n \"bucketPath\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/update", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "update" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n },\n \"signedUrl\": {\n \"value\": \"\"\n },\n \"bucketBucket\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Rotate upload portal token", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "rotate-token" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Rotates the token for an upload portal." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/rotate-token", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "rotate-token" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete upload portal", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "delete" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Deletes an upload portal for the organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/:portalId/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", ":portalId", "delete" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" }, { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "List upload portals", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all configured upload portals." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"portals\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create upload portal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bucketId\": \"\",\n \"bucketPath\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", "create" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Creates a new upload portal for the organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"bucketId\": \"\",\n \"bucketPath\": \"\",\n \"description\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/portals/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "portals", "create" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"url\": {\n \"value\": \"\"\n },\n \"signedUrl\": {\n \"value\": \"\"\n },\n \"bucketBucket\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Organization information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "List all information about this organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organization\": {\n \"value\": \"\"\n },\n \"datasets\": {\n \"value\": \"\"\n },\n \"defaultComputeLimits\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"readme\": {\n \"value\": \"\"\n },\n \"whitelabelId\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update organization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"headerImg\": \"\",\n \"name\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"readme\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Update organization properties such as name and logo." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"headerImg\": \"\",\n \"name\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"readme\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove organization", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Remove the current organization, and all data associated with it. This is irrevocable!" }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Upload organization logo", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "type": "file", "value": null } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/logo", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "logo" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Uploads and updates the organization logo" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/logo", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "logo" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Upload organization header image", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/header", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "header" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Uploads and updates the organization header image" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/header", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "header" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Admin endpoint", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/test-admin", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "test-admin" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Test endpoint that can only be reached with admin rights." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/test-admin", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "test-admin" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "projects" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Retrieve all projects for the organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/projects", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "projects" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"projects\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Upload image for readme", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "image", "value": "", "type": "text", "description": "(Required) " } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/readme/upload-image", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "readme", "upload-image" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Uploads an image to the user CDN and returns the path." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "image", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/readme/upload-image", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "readme", "upload-image" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Upload a custom block", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "tar", "type": "file", "description": "(Required) ", "value": null }, { "key": "type", "value": "", "type": "text", "description": "(Required) (This can only be one of transform,deploy,dsp,transferLearning)" }, { "key": "blockId", "value": "", "type": "text", "description": "(Required) " } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/custom-block", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "custom-block" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Upload a zip file containing a custom transformation or deployment block." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) ", "key": "tar", "value": "", "type": "text" }, { "description": "(Required) (This can only be one of transform,deploy,dsp,transferLearning)", "key": "type", "value": "", "type": "text" }, { "description": "(Required) ", "key": "blockId", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/custom-block", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "custom-block" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create new empty project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectName\": \"\",\n \"projectOwnerUsernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/new-project", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "new-project" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Create a new empty project within an organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"projectName\": \"\",\n \"projectOwnerUsernameOrEmail\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/new-project", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "new-project" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Add a collaborator to a project within an organisation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"\",\n \"userId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/add-project-collaborator", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "add-project-collaborator" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Add a new collaborator to a project owned by an organisation." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"projectId\": \"\",\n \"userId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/add-project-collaborator", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "add-project-collaborator" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get socket token for an organization", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/socket-token", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "socket-token" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Get a token to authenticate with the web socket interface." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations/:organizationId/socket-token", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", ":organizationId", "socket-token" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "List active organizations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations" ] }, "description": "Retrieve list of organizations that a user is a part of. If authenticating using JWT token this lists all the organizations the user has access to, if authenticating using an API key, this only lists that organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organizations\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create new organization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "create" ] }, "description": "Create a new organization. This is an internal API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/organizations/create", "host": [ "{{baseUrl}}" ], "path": [ "api", "organizations", "create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "admin", "item": [ { "name": "users", "item": [ { "name": "{userId}", "item": [ { "name": "Get user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Admin-only API to get information about a user." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"user\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Admin-only API to update user properties." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/users/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete a user", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/users/:userId?fullDeletion=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId" ], "query": [ { "key": "fullDeletion", "value": "", "description": "Set to true for full deletion" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Admin-only API to delete a user. If `fullDeletion` is set, it deletes the user's identifiable information and files. Otherwise, it soft deletes the user by setting it's `delete_date` value." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/users/:userId?fullDeletion=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId" ], "query": [ { "key": "fullDeletion", "value": "" } ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get user metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/users/:userId/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId", "metrics" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Admin-only API to get marketing metrics about a user." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/users/:userId/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users", ":userId", "metrics" ], "variable": [ { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"metrics\": {\n \"value\": \"\"\n },\n \"labels\": -21194993,\n \"classificationType\": \"Ut consequat exercitation voluptate\"\n}" } ] } ] }, { "name": "Get all users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/users?user=&active=&tier=&fields=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users" ], "query": [ { "key": "user", "value": "", "description": "Part of e-mail address or username" }, { "key": "active", "value": "", "description": "Whether to search for entities (users, orgs) active in the last X days" }, { "key": "tier", "value": "", "description": "Whether to search for free, pro or enterprise entities (users, projects)" }, { "key": "fields", "value": "", "description": "Comma separated list of fields to fetch in a query" }, { "key": "sort", "value": "", "description": "Fields and order to sort query by" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ] }, "description": "Admin-only API to get the list of all registered users." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/users?user=&active=&tier=&fields=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users" ], "query": [ { "key": "user", "value": "" }, { "key": "active", "value": "" }, { "key": "tier", "value": "" }, { "key": "fields", "value": "" }, { "key": "sort", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"users\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "projects", "item": [ { "name": "{projectId}", "item": [ { "name": "members", "item": [ { "name": "Add user to a project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/members", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "members" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Admin-only API to add a user to a project. If no user is provided, the current user is used." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/members", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "members" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove user from a project", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/members/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "members", ":userId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] }, "description": "Admin-only API to remove a user from a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/members/:userId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "members", ":userId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" }, { "key": "userId", "value": "", "description": "(Required) User ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get project", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Admin-only API to get project information." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"project\": {\n \"value\": \"\"\n },\n \"developmentKeys\": {\n \"value\": \"\"\n },\n \"impulse\": {\n \"value\": \"\"\n },\n \"devices\": {\n \"value\": \"\"\n },\n \"dataSummary\": {\n \"value\": \"\"\n },\n \"dataSummaryFiltered\": {\n \"value\": \"\"\n },\n \"dataSummaryPerCategory\": {\n \"value\": \"\"\n },\n \"computeTime\": {\n \"value\": \"\"\n },\n \"acquisitionSettings\": {\n \"value\": \"\"\n },\n \"collaborators\": {\n \"value\": \"\"\n },\n \"deploySettings\": {\n \"value\": \"\"\n },\n \"experiments\": {\n \"value\": \"\"\n },\n \"latencyDevices\": {\n \"value\": \"\"\n },\n \"urls\": {\n \"value\": \"\"\n },\n \"showCreateFirstImpulse\": {\n \"value\": \"\"\n },\n \"showProjectTypeWizard\": {\n \"value\": \"\"\n },\n \"showGettingStartedWizard\": {\n \"value\": \"\"\n },\n \"performance\": {\n \"value\": \"\"\n },\n \"trainJobNotificationUids\": {\n \"value\": \"\"\n },\n \"dspJobNotificationUids\": {\n \"value\": \"\"\n },\n \"modelTestingJobNotificationUids\": {\n \"value\": \"\"\n },\n \"exportJobNotificationUids\": {\n \"value\": \"\"\n },\n \"hasNewTrainingData\": {\n \"value\": \"\"\n },\n \"readme\": {\n \"value\": \"\"\n },\n \"csvImportConfig\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update project", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"lastDeployEonCompiler\": \"\",\n \"latencyDevice\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"showCreateFirstImpulse\": \"\",\n \"labelingMethod\": \"\",\n \"showProjectTypeWizard\": \"\",\n \"selectedProjectTypeInWizard\": \"\",\n \"gettingStartedStep\": \"\",\n \"useGpu\": \"\",\n \"computeTimeLimitM\": \"\",\n \"dspFileSizeMb\": \"\",\n \"enterprisePerformance\": \"\",\n \"trainJobRamMb\": \"\",\n \"metadata\": \"\",\n \"readme\": \"\",\n \"lastAcquisitionLabel\": \"\",\n \"trainJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelTestingJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exportJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"csvImportConfig\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Admin-only API to update project properties." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"lastDeployEonCompiler\": \"\",\n \"latencyDevice\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"showCreateFirstImpulse\": \"\",\n \"labelingMethod\": \"\",\n \"showProjectTypeWizard\": \"\",\n \"selectedProjectTypeInWizard\": \"\",\n \"gettingStartedStep\": \"\",\n \"useGpu\": \"\",\n \"computeTimeLimitM\": \"\",\n \"dspFileSizeMb\": \"\",\n \"enterprisePerformance\": \"\",\n \"trainJobRamMb\": \"\",\n \"metadata\": \"\",\n \"readme\": \"\",\n \"lastAcquisitionLabel\": \"\",\n \"trainJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"dspJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"modelTestingJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"exportJobNotificationUids\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"csvImportConfig\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete a project", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "Admin-only API to delete a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Add current user to a project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "add" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "DEPRECATED. Admin-only API to add the current user to a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/add", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "add" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Remove current user from a project", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "remove" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] }, "description": "DEPRECATED. Admin-only API to remove the current user from a project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects/:projectId/remove", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects", ":projectId", "remove" ], "variable": [ { "key": "projectId", "value": "", "description": "(Required) Project ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get all projects", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects" ], "query": [ { "key": "name", "value": "", "description": "Part of an entity name (could be a project, an org...)" }, { "key": "active", "value": "", "description": "Whether to search for entities (users, orgs) active in the last X days" }, { "key": "sort", "value": "", "description": "Fields and order to sort query by" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ] }, "description": "Admin-only API to get the list of all projects." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/projects?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "projects" ], "query": [ { "key": "name", "value": "" }, { "key": "active", "value": "" }, { "key": "sort", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" } ] } ] }, { "name": "organizations", "item": [ { "name": "{organizationId}", "item": [ { "name": "Organization information", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Admin-only API to list all information about this organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"billable\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Update organization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"headerImg\": \"\",\n \"name\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"readme\": \"\",\n \"billable\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Admin-only API to update organization properties such as name and logo." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"logo\": \"\",\n \"headerImg\": \"\",\n \"name\": \"\",\n \"experiments\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"readme\": \"\",\n \"billable\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/organizations/:organizationId", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations", ":organizationId" ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Delete an organization", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/organizations/:organizationId?fullDeletion=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations", ":organizationId" ], "query": [ { "key": "fullDeletion", "value": "", "description": "Set to true for full deletion" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] }, "description": "Admin-only API to delete an organization. If `fullDeletion` is set, it deletes the organization's identifiable information and files. Otherwise, it soft deletes the organization by setting its `delete_date` value." }, "response": [ { "name": "OK", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/organizations/:organizationId?fullDeletion=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations", ":organizationId" ], "query": [ { "key": "fullDeletion", "value": "" } ], "variable": [ { "key": "organizationId", "value": "", "description": "(Required) Organization ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get all organizations", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/organizations?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations" ], "query": [ { "key": "name", "value": "", "description": "Part of an entity name (could be a project, an org...)" }, { "key": "active", "value": "", "description": "Whether to search for entities (users, orgs) active in the last X days" }, { "key": "sort", "value": "", "description": "Fields and order to sort query by" }, { "key": "limit", "value": "", "description": "Maximum number of results" }, { "key": "offset", "value": "", "description": "Offset in results, can be used in conjunction with LimitResultsParameter to implement paging." } ] }, "description": "Admin-only API to get the list of all organizations." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/organizations?name=&active=&sort=&limit=&offset=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations" ], "query": [ { "key": "name", "value": "" }, { "key": "active", "value": "" }, { "key": "sort", "value": "" }, { "key": "limit", "value": "" }, { "key": "offset", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"organizations\": {\n \"value\": \"\"\n },\n \"total\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create a new organization", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"\",\n \"adminId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations" ] }, "description": "Admin-only API to create a new organization." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"organizationName\": \"\",\n \"adminId\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/admin/organizations", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "organizations" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": {\n \"value\": \"\"\n },\n \"apiKey\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "users-ids", "item": [ { "name": "Get all user IDs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/users-ids", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users-ids" ] }, "description": "DEPRECATED. Admin-only API to get list of all users." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/users-ids", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users-ids" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ids\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get all user IDs (active last 30 days)", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/users-ids/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users-ids", "active" ] }, "description": "DEPRECATED. Admin-only API to get list of all users that have been active in the past 30 days." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/users-ids/active", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "users-ids", "active" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"ids\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Get global metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "metrics" ] }, "description": "Admin-only API to get global metrics." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/metrics", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "metrics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"metrics\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Find a user", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/admin/find-user?query=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "find-user" ], "query": [ { "key": "query", "value": "", "description": "(Required) Part of e-mail address or username" } ] }, "description": "DEPRECATED. Admin-only API to find a user by username or email address." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/admin/find-user?query=", "host": [ "{{baseUrl}}" ], "path": [ "api", "admin", "find-user" ], "query": [ { "key": "query", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"users\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "portals/{portalId}", "item": [ { "name": "files", "item": [ { "name": "List files in portal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"prefix\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "List all files and directories in specified prefix." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"prefix\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"files\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Delete file from portal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "delete" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Delete a file from an upload portal (requires JWT auth)." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/delete", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "delete" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Rename file from portal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"oldPath\": \"\",\n \"newPath\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/rename", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "rename" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Rename a file on an upload portal (requires JWT auth)." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"oldPath\": \"\",\n \"newPath\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/rename", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "rename" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Download file from portal", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/download", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "download" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Download a file from an upload portal (requires JWT auth). Will return a signed URL to the bucket." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"path\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/download", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "download" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "View file from portal", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/view?path=", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "view" ], "query": [ { "key": "path", "value": "", "description": "(Required) Path to file in portal" } ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "View a file that's located in an upload portal (requires JWT auth). Will return a signed URL to the bucket." }, "response": [ { "name": "A redirect to a signed URL to view this file", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/portals/:portalId/files/view?path=", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "files", "view" ], "query": [ { "key": "path", "value": "" } ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "Found", "code": 302, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" } ] } ] }, { "name": "Portal info", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/portals/:portalId", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Get information about a portal" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/portals/:portalId", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"description\": \"\",\n \"organizationId\": \"\",\n \"organizationName\": \"\",\n \"organizationLogo\": \"\"\n}" } ] }, { "name": "Create pre-signed S3 upload link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"fileHash\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/upload-link", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "upload-link" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] }, "description": "Creates a signed link to securely upload data to s3 bucket directly from the client." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"fileName\": \"\",\n \"fileSize\": \"\",\n \"fileHash\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/portals/:portalId/upload-link", "host": [ "{{baseUrl}}" ], "path": [ "api", "portals", ":portalId", "upload-link" ], "variable": [ { "key": "portalId", "value": "", "description": "(Required) Portal ID" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"url\": {\n \"value\": \"\"\n },\n \"ETag\": {\n \"value\": \"\"\n }\n}" } ] } ] }, { "name": "Deployment targets", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/deployment/targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "deployment", "targets" ] }, "description": "List all deployment targets" }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/deployment/targets", "host": [ "{{baseUrl}}" ], "path": [ "api", "deployment", "targets" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"targets\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get studio api containers health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/api-health?requester=", "host": [ "{{baseUrl}}" ], "path": [ "api", "api-health" ], "query": [ { "key": "requester", "value": "", "description": "Health check requester" } ] }, "description": "Get studio api containers health." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/api-health?requester=", "host": [ "{{baseUrl}}" ], "path": [ "api", "api-health" ], "query": [ { "key": "requester", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" }, { "name": "Unhealthy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api/api-health?requester=", "host": [ "{{baseUrl}}" ], "path": [ "api", "api-health" ], "query": [ { "key": "requester", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] } ] }, { "name": "Get JWT token", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"uuid\": \"\",\n \"ssoType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-login", "host": [ "{{baseUrl}}" ], "path": [ "api-login" ] }, "description": "Get a JWT token to authenticate with the API." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"uuid\": \"\",\n \"ssoType\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-login", "host": [ "{{baseUrl}}" ], "path": [ "api-login" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": {\n \"value\": \"\"\n },\n \"redirectUrl\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create user", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"privacyPolicy\": \"\",\n \"password\": \"\",\n \"projectName\": \"\",\n \"activationToken\": \"\",\n \"identityProvider\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-create", "host": [ "{{baseUrl}}" ], "path": [ "api-user-create" ] }, "description": "Create a new user and project" }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"privacyPolicy\": \"\",\n \"password\": \"\",\n \"projectName\": \"\",\n \"activationToken\": \"\",\n \"identityProvider\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-create", "host": [ "{{baseUrl}}" ], "path": [ "api-user-create" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"redirectUrl\": {\n \"value\": \"\"\n },\n \"id\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Create evaluation user", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api-user-create-evaluate", "host": [ "{{baseUrl}}" ], "path": [ "api-user-create-evaluate" ] }, "description": "Creates an evaluation user and a new project, and redirects the user to the new project." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api-user-create-evaluate", "host": [ "{{baseUrl}}" ], "path": [ "api-user-create-evaluate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": {\n \"value\": \"\"\n },\n \"redirectUrl\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Get user password state", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api-user-need-to-set-password/:usernameOrEmail", "host": [ "{{baseUrl}}" ], "path": [ "api-user-need-to-set-password", ":usernameOrEmail" ], "variable": [ { "key": "usernameOrEmail", "value": "", "description": "(Required) Username or email" } ] }, "description": "Tells whether the user needs to set its password." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api-user-need-to-set-password/:usernameOrEmail", "host": [ "{{baseUrl}}" ], "path": [ "api-user-need-to-set-password", ":usernameOrEmail" ], "variable": [ { "key": "usernameOrEmail", "value": "", "description": "(Required) Username or email" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"email\": {\n \"value\": \"\"\n },\n \"needPassword\": {\n \"value\": \"\"\n },\n \"whitelabels\": {\n \"value\": \"\"\n }\n}" } ] }, { "name": "Request reset password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-request-reset-password", "host": [ "{{baseUrl}}" ], "path": [ "api-user-request-reset-password" ] }, "description": "Request a password reset link for a user." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-request-reset-password", "host": [ "{{baseUrl}}" ], "path": [ "api-user-request-reset-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Reset password", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"code\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-reset-password", "host": [ "{{baseUrl}}" ], "path": [ "api-user-reset-password" ] }, "description": "Reset the password for a user." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"code\": \"\",\n \"newPassword\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-reset-password", "host": [ "{{baseUrl}}" ], "path": [ "api-user-reset-password" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Verify reset password code", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-verify-reset-password-code", "host": [ "{{baseUrl}}" ], "path": [ "api-user-verify-reset-password-code" ] }, "description": "Verify whether the reset password code for the user is valid." }, "response": [ { "name": "OK", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"code\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api-user-verify-reset-password-code", "host": [ "{{baseUrl}}" ], "path": [ "api-user-verify-reset-password-code" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "User CDN resource", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "image/jpeg" } ], "url": { "raw": "{{baseUrl}}/api-usercdn?path=", "host": [ "{{baseUrl}}" ], "path": [ "api-usercdn" ], "query": [ { "key": "path", "value": "", "description": "(Required) CDN Path" } ] }, "description": "Proxy function to retrieve data from the user CDN. This function is only used during development." }, "response": [ { "name": "Image", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api-usercdn?path=", "host": [ "{{baseUrl}}" ], "path": [ "api-usercdn" ], "query": [ { "key": "path", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "image/jpeg" } ], "cookie": [], "body": "" } ] }, { "name": "Get studio web containers health", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api-health?requester=", "host": [ "{{baseUrl}}" ], "path": [ "api-health" ], "query": [ { "key": "requester", "value": "", "description": "Health check requester" } ] }, "description": "Get studio web containers health." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api-health?requester=", "host": [ "{{baseUrl}}" ], "path": [ "api-health" ], "query": [ { "key": "requester", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" }, { "name": "Unhealthy", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api-health?requester=", "host": [ "{{baseUrl}}" ], "path": [ "api-health" ], "query": [ { "key": "requester", "value": "" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"success\": \"\",\n \"error\": \"\"\n}" } ] }, { "name": "Get public metrics", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api-metrics" ] }, "description": "Get information about number of projects, compute and data samples. Updated once per hour." }, "response": [ { "name": "OK", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "x-api-key", "value": "" } ], "url": { "raw": "{{baseUrl}}/api-metrics", "host": [ "{{baseUrl}}" ], "path": [ "api-metrics" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"projects\": {\n \"value\": \"\"\n },\n \"data_samples\": {\n \"value\": \"\"\n },\n \"jobs\": {\n \"value\": \"\"\n }\n}" } ] } ], "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "{{x-api-key}}", "type": "string" }, { "key": "key", "value": "x-api-key", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "const loginPostRequest = {", " url: pm.collectionVariables.get('baseUrl') + \"/api-login\",", " method: 'POST',", " header: 'Content-Type:application/json',", " body: {", " mode: 'application/json',", " raw: JSON.stringify(", " {", " \tusername: pm.collectionVariables.get('username'),", " \tpassword: pm.collectionVariables.get('password')", " })", " }", "};", "", "pm.sendRequest(loginPostRequest, function (err, response) {", " pm.collectionVariables.set(\"x-jwt-token\", response.json().token);", "});" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "baseUrl", "value": "https://studio.edgeimpulse.com/v1" }, { "key": "x-jwt-token", "value": "x-jwt-token" }, { "key": "username", "value": "username" }, { "key": "password", "value": "password" } ] }