![\"\"](\"https://i.imgur.com/6dx3mp9.jpg\")
Welcome to the API documentation for Trainingset.ai platform! It's an easy to use API organized around REST with predictable resource-oriented URLs and you will enjoy it. With the methods described here you will be able to create, access, and delete tasks and projects.
\nIf you are using Python, check out the Trainingset.ai Python SDK.
\nNOTE: Postman is currently having issues with \"Run in Postman\" button working in Linux and Mac environments.
\nThere are seven types of tasks you can create, each representing a different type of annotation you can get over your images or a categorization task. The six annotation types are Box, Segmentation, PCD (LiDAR), Point, Line, Polygon and image categorization.
\n
![\"\"](\"https://i.imgur.com/VUmppes.jpg\")
The Trainingsetai API uses API keys to authenticate requests. They are sent in the request header inside \"user_key\" parameter. You can view and manage your API keys in the Trainingsetai Dashboard.
\nTrainingsetai uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with Trainingsetai's servers (these are rare).
\n\nYou can add tasks from dashboard by uploading a CSV file.
\nRules for adding tasks from CSV are equal to the rules of adding a task by API. Just follow this API document to check what are the attribute names for the type of task you are uploading, which values are allowed and if they are mandatory.
\nSome other rules to help you out uploading your tasks:
\nCheck out some of our examples which you can try on your own:
\n\n\n\n\n\n\nPoint cloud (LiDAR) annotation
\nAfter you upload your task, our model is going to annotate the attachment (currently only 2D images can be auto-annotated). In order to enable automatic annotations set automatic_prelabel attribute to true and wait a couple of minutes after the task has been added. Once our model is finished, the results will be available in metadata attribute.
This is the list of labels which are supported and can be automatically annotated for polygon, box and segmentation annotation tasks:
\nperson, bicycle, car, motorcycle, airplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, couch, potted plant, bed, dining table, toilet, tv, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy bear, hair drier, toothbrush
This is the list of labels which are supported and can be automatically annotated for line annotation tasks:
\nlane
This is the list of labels which are supported and can be automatically annotated for classification annotation tasks:
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Tasks types","slug":"tasks-types"},{"content":"Authentication","slug":"authentication"},{"content":"HTTP status code summary","slug":"http-status-code-summary"},{"content":"Adding tasks from CSV file","slug":"adding-tasks-from-csv-file"},{"content":"Automatic annotations","slug":"automatic-annotations"},{"content":"Automatic annotations label list","slug":"automatic-annotations-label-list"}],"owner":"10426338","collectionId":"d1457d16-3084-42d9-acb5-f3e0a79206fd","publishedId":"Szf9V75M","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"444444","highlight":"F75E60"},"publishDate":"2020-09-22T09:14:22.000Z"},"item":[{"name":"Managing tasks","item":[{"name":"CREATE POINT ANNOTATION TASK","event":[{"listen":"test","script":{"id":"29bd0b73-1ae8-46fc-bfdc-f659927745fa","exec":["pm.test(\"Status test\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Structure test\", function () {"," pm.response.to.be.json;","});","","","pm.test(\"Set the ID\", function () {"," const response = pm.response.json();"," pm.environment.set(\"task_id\", response[0]._id);","});"],"type":"text/javascript"}}],"id":"557e27b5-5a89-4d9b-92ab-196b8b62bff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user_key","type":"text","value":"{{user_key}}","description":"Parameter representing the key for access to requests
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"instructions","value":"Draw a dot over each tomato","description":"Instructions for drawing the task (Required) (String)
\n","type":"text"},{"key":"attachment_url","value":"https://i.imgur.com/LtQGobF.jpg","description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","type":"text"},{"key":"with_labels","value":"true","description":"Define if the task has tags (Optional) (Boolean)
\n","type":"text"},{"key":"objects_to_annotate","value":"[{\"label\": \"tomatoes\", \"color\": \"rgba(255,99,71,1)\"}]","description":"List of objects to be annotated (Optional) (AnnotationObject Array)
\n","type":"text"},{"key":"project","value":"fruit-recognizer","description":"Name of the project that belongs to the task (Optional) (String)
\n","type":"text"},{"key":"callback_url","value":"https://my-server.com/my-results","description":"URL to which you will get task results delivered (Optional) (String)
\n","type":"text"},{"key":"automatic_prelabel","value":"false","description":"Automatically prelabel the picture (Optional) (Boolean)
\n","type":"text"}]},"url":"{{url}}/api/task/annotation/point","description":"Creates a point type annotation task.
\n![](\"https://i.imgur.com/LtQGobF.jpg\")
Parameter representing the key for access to requests
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"instructions","value":"Draw a polygon around each pool","description":"Instructions for drawing the task (Required) (String)
\n","type":"text"},{"key":"attachment_url","value":"https://i.imgur.com/St0ZI0Z.jpg","description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","type":"text"},{"key":"with_labels","value":"true","description":"Define if the task has tags (Optional) (Boolean)
\n","type":"text"},{"key":"objects_to_annotate","value":"[{\"label\": \"pools\"}]","description":"List of objects to be annotated (Optional) (AnnotationObject Array)
\n","type":"text"},{"key":"project","value":"pool-recognizer","description":"Name of the project that belongs to the task (Optional) (String)
\n","type":"text"},{"key":"min_vertices","value":"4","description":"Minimum number of vertices that a polygon drawn in the task must have (Optional)(Number)
\n","type":"text"},{"key":"max_vertices","value":"250","description":"Maximum number of vertices that a polygon drawn in the task must have (Optional)(Number)
\n","type":"text"},{"key":"callback_url","value":"https://my-server.com/my-results","description":"URL to which you will get task results delivered (Optional) (String)
\n","type":"text"},{"key":"automatic_prelabel","value":"false","description":"Automatically prelabel the picture (Optional) (Boolean)
\n","type":"text"}]},"url":"{{url}}/api/task/annotation/polygon","description":"Creates a polygon type annotation task.
\n![](\"https://i.imgur.com/St0ZI0Z.jpg\")
Parameter representing the key for access to requests
\n"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"instructions","value":"Draw a box around each rooftop","description":"Instructions for drawing the task (Required) (String)
\n","type":"text"},{"key":"attachment_url","value":"https://i.imgur.com/PIadhUz.jpg","description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","type":"text"},{"key":"min_height","value":"10","description":"Minimum height of each box drawn in the task (Optional) (Number)
\n","type":"text"},{"key":"min_width","value":"20","description":"Minimum width of each box drawn in the task (Optional) (Number)
\n","type":"text"},{"key":"with_labels","value":"true","description":"Define if the task has tags (Optional) (Boolean)
\n","type":"text"},{"key":"objects_to_annotate","value":"[{\"label\": \"rooftops\"}]","description":"List of objects to be annotated (Optional) (AnnotationObject Array)
\n","type":"text"},{"key":"project","value":"maps","description":"Name of the project that belongs to the task (Optional) (String)
\n","type":"text"},{"key":"callback_url","value":"https://my-server.com/my-results","description":"URL to which you will get task results delivered (Optional) (String)
\n","type":"text"},{"key":"automatic_prelabel","value":"false","description":"Automatically prelabel the picture (Optional) (Boolean)
\n","type":"text"}]},"url":"{{url}}/api/task/annotation/box","description":"Creates a box type annotation task.
\n![](\"https://i.imgur.com/PIadhUz.jpg\")
Parameter representing the key for access to requests
\n","key":"user_key","type":"text","value":"{{user_key}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Instructions for drawing the task (Required) (String)
\n","key":"instructions","type":"text","value":"Draw a line over each line and circle of the field"},{"description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","key":"attachment_url","type":"text","value":"https://i.imgur.com/Ml3nfz7.jpg"},{"description":"Define if the task has tags (Optional) (Boolean)
\n","key":"with_labels","type":"text","value":"true"},{"description":"List of objects to be annotated (Optional) (AnnotationObject Array)
\n","key":"objects_to_annotate","type":"text","value":"[{\"label\": \"lines\"},{\"label\": \"circles\"}]"},{"description":"Name of the project that belongs to the task (Optional) (String)
\n","key":"project","type":"text","value":"football-fields"},{"description":"Minimum number of vertices that a polygon drawn in the task must have (Optional)(Number)
\n","key":"min_vertices","type":"text","value":"2"},{"description":"Maximum number of vertices that a polygon drawn in the task must have (Optional)(Number)
\n","key":"max_vertices","type":"text","value":"150"},{"key":"callback_url","value":"https://my-server.com/my-results","description":"URL to which you will get task results delivered (Optional) (String)
\n","type":"text"},{"key":"automatic_prelabel","value":"false","description":"Automatically prelabel the picture (Optional) (Boolean)
\n","type":"text"}]},"url":"{{url}}/api/task/annotation/line","description":"Creates a line type annotation task.
\n![](\"https://i.imgur.com/Ml3nfz7.jpg\")
Instructions for performing the task (Required) (String)
\n","type":"text"},{"key":"attachment_url","value":"https://i.imgur.com/LulwSYw.png","description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","type":"text"},{"key":"with_labels","value":"false","description":"Define if the task has tags (Optional) (Boolean)
\n","type":"text"},{"key":"project","value":"categorizations-for-testing","description":"Name of the project that belongs to the task (Optional) (String)
\n","type":"text"},{"key":"callback_url","value":"https://my-server.com/my-results","description":"URL to which you will get task results delivered (Optional) (String)
\n","type":"text"},{"key":"categories","value":"[\"animal\", \"human\", \"turtle\", \"gold fish\", \"sea\", \"land\", \"shark\", \"dog\", \"cat\", \"monkey\", \"squid\"]","description":"Categories into which an image can be categorized (Required) (String Array)
\n","type":"text"},{"key":"allow_multiple","value":"true","description":"Allow multiple categories to be selected (Optional) (Boolean)
\n","type":"text"}]},"url":"{{url}}/api/task/categorization/image","description":"Creates an image categorization task.
\n![](\"https://i.imgur.com/LulwSYw.png\")
Parameter representing the key for access to requests
\n","key":"user_key","type":"text","value":"{{user_key}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Instructions for drawing the task (Required) (String)
\n","key":"instructions","type":"text","value":"Annotate the scene with provided labels"},{"description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","key":"attachment_url","type":"text","value":"https://s3.us-east-2.amazonaws.com/trainingset.ai/test/n015-2018-07-24-11-22-45%2B0800__LIDAR_TOP__1532402883948604.pcd"},{"description":"Define if the task has tags (Optional) (Boolean)
\n","key":"with_labels","type":"text","value":"true"},{"description":"List of objects to be annotated (Optional) (AnnotationObject Array)
\n","key":"objects_to_annotate","type":"text","value":"[{\"label\": \"pedestrian\", \"color\": \"rgba(230, 25, 75, 1)\"},{\"label\": \"pedestrian\", \"color\": \"rgba(60, 180, 75, 1)\"}]"},{"description":"Name of the project that belongs to the task (Optional) (String)
\n","key":"project","type":"text","value":"self-driving"},{"description":"URL to which you will get task results delivered (Optional) (String)
\n","key":"callback_url","type":"text","value":"https://my-server.com/my-results"},{"key":"cameras","value":"[\n {\n \"name\": \"CAM_FRONT\",\n \"url\": \"https://i.imgur.com/i3IJ2SZ.png\",\n \"translation_matrix\": [\n [1, 0, 0, 0],\n [0, 0, 0, -0.45],\n [0, 0, 0, -0.64],\n [0, 0, 0, 1]\n ],\n \"rotation_matrix\": [\n [0, -1, 0, 0],\n [0, 0, -1, 0],\n [1, 0, 0, 0],\n [0, 0, 0, 1]\n ],\n \"camera_intrinsic\": [\n [1449.144043, 0, 1199.158041, 0],\n [0, 1456.590741, 1036.123288, 0],\n [0, 0, 1, 0],\n [0, 0, 0, 1]\n ],\n \"distortion_coefficients\": [0, 0, 0, 0, 0],\n \"origin\": [0, 0, 0]\n }\n]","description":"Camera parameters, each camera is an object (Optional) (CameraObject Array)
\n","type":"text"}]},"url":"{{url}}/api/task/annotation/pcd","description":"Creates a PCD (LiDAR) type annotation task.
\n![](\"https://i.imgur.com/hu7RHw1.png\")
If you are providing camera images, this is the clarification of camera object structure:
\nRotation matrix:\n[[r11,r12,r13,0],\n[r21,r22,r23,0],\n[r31,r32,r33,0],\n[0, 0, 0, 1]]\nr11, r12 ... r33 - Rotation components between LiDAR and camera in LiDAR frame of reference\n\nTranslation matrix:\n[[1,0,0,tx],\n[0,0,0,ty],\n[0,0,0,tz],\n[0,0,0,1]]\ntx, ty and tz - Translation between LiDAR and camera in LiDAR frame of reference\n\nCamera intrinsic:\n[[fx, 0, cx, 0],\n[0, fy, cy, 0],\n[0, 0, 1, 0]\n[0, 0, 0, 1]]\nfx and fy - Focal lenghts in pixels\n\nDistortion coefficients (optional):\n[k1,k2,p1,p2, k3]\nk1, k2, and k3 — Radial distortion coefficients of the lens\np1 and p2 - Tangential distortion coefficients of the lens\n\nOrigin (optional):\n[x, y, z]\nCoordinates of the camera in 3D world\nParameter representing the key for access to requests
\n","key":"user_key","type":"text","value":"{{user_key}}"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"Instructions for drawing the task (Required) (String)
\n","key":"instructions","type":"text","value":"Segmentate the image with provided labels"},{"description":"HTTP/HTTPS Image address where the drawing of the task is carried out (Required) (String)
\n","key":"attachment_url","type":"text","value":"https://i.imgur.com/TRIDUEk.jpg"},{"description":"Define if the task has tags (Optional) (Boolean)
\n","key":"with_labels","type":"text","value":"true"},{"description":"List of objects to be annotated (Optional) (AnnotationObject Array)
\n","key":"objects_to_annotate","type":"text","value":"[{\"label\": \"Car\"}, {\"label\": \"Person\"}, {\"label\": \"Building\"}, {\"label\": \"Road\"}]"},{"description":"Name of the project that belongs to the task (Optional) (String)
\n","key":"project","type":"text","value":"self-driving"},{"description":"URL to which you will get task results delivered (Optional) (String)
\n","key":"callback_url","type":"text","value":"https://my-server.com/my-results"},{"key":"automatic_prelabel","value":"true","description":"Automatically prelabel the picture (Optional) (Boolean)
\n","type":"text"}]},"url":"{{url}}/api/task/annotation/segmentation","description":"Creates a segmentation type annotation task.
\n![](\"https://i.imgur.com/oImZEse.png\")
Attach existing annotations to the task. metadata attribute can have annotation-point, annotation-box, annotation-line or annotation-polygon keys where their values are result objects. Result object follows the same structure that we use on these task types.
validate attribute is optional, if you wish, you can set it to true in order to verify that your request body is valid without saving the metadata.
Parameter representing the key for access to requests
\n","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/api/task/{{task_id}}","description":"Deletes a task.
\n","urlObject":{"path":["api","task","{{task_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"62cbcff2-3dc3-43a4-9c05-d78e43214490","name":"DELETE TASK","originalRequest":{"method":"DELETE","header":[{"key":"user_key","value":"{{user_key}}","description":"Parameter representing the key for access to requests","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{url}}/api/task/{{task_id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"20805e61-9d56-49f3-af45-b38254ce9366"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"46"},{"key":"Etag","value":"W/\"2e-Jqj9aFsQUIeB2pfuzsGDQ5Z1XLE\""},{"key":"Date","value":"Tue, 22 Sep 2020 09:38:00 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Task deleted!\"\n}"}],"_postman_id":"59207e5a-888e-4e4c-bada-714f6f35751c"},{"name":"RETRIEVE TASKS DATA","id":"31015045-26be-4494-b9ac-870576b8a7c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","type":"text","value":"{{user_key}}","description":"Parameter representing the key for access to requests
\n"}],"url":"{{url}}/api/task/","description":"Function that returns an array of objects with task data.
\n","urlObject":{"path":["api","task",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"31015045-26be-4494-b9ac-870576b8a7c9"},{"name":"RETRIEVE TASK DATA BY PROJECT","id":"386662a6-f0eb-414d-8b9d-55a4ba003e90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","type":"text","value":"{{user_key}}","description":"Parameter representing the key for access to requests
\n"}],"url":"{{url}}/api/task/project/{{project_name}}","description":"Returns an object array with all the tasks that requested project contains.
\n","urlObject":{"path":["api","task","project","{{project_name}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"44fee44b-9447-49a4-83a8-7534795fd8cc","name":"RETRIVE TASK DATA BY PROJECT","originalRequest":{"method":"GET","header":[{"key":"user_key","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkMTRjYTY3YWY2ZmYxMDAwNDJjNmI0MSIsImlhdCI6MTU2NTA5ODU0MywiZXhwIjoxNTY1MTAwMzQzfQ.xjrbmuOP1HaXcu-uZjN3qEfPJiX38-kQW4TanfYz2Ys","description":"Parameter representing the key for access to requests"}],"url":"{{url}}/api/task/project/Projectname"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"a8010f6a-b4b6-4a33-92a8-992628f12048"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2164"},{"key":"Etag","value":"W/\"874-bfe+L4S/ZlsfWlrVGtBc71wbTvU\""},{"key":"Date","value":"Tue, 06 Aug 2019 14:01:11 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5d49858c70f5a100043f0b41\",\n \"created_at\": \"2019-08-06T13:50:04.812Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"pending\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw a box for each car\",\n \"note\":\"Completed drawing\",\n \"project\": \"Projectname\",\n \"priority\": 1,\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2017/02/12/21/29/false-2061132_960_720.png\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car blue\",\n \"car yelow\"\n ],\n \"min_height\": 10,\n \"min_width\": 20,\n \"userId\": null\n },\n {\n \"_id\": \"5d49860d70f5a100043f0b42\",\n \"created_at\": \"2019-08-06T13:52:13.425Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-point\",\n \"status\": \"pending\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw a dot for each car\",\n \"project\": \"Projectname\",\n \"priority\": 2,\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2017/02/12/21/29/false-2061132_960_720.png\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car blue\",\n \"car yelow\"\n ],\n \"userId\": null\n },\n {\n \"_id\": \"5d49864d70f5a100043f0b43\",\n \"key\": [],\n \"created_at\": \"2019-08-06T13:53:17.730Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-line\",\n \"status\": \"pending\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw a line in border of each car\",\n \"project\": \"Projectname\",\n \"priority\": 3,\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2017/02/12/21/29/false-2061132_960_720.png\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car blue\",\n \"card yelow\"\n ],\n \"min_vertices\": 2,\n \"max_vertices\": 150,\n \"userId\": null\n },\n {\n \"_id\": \"5d49867770f5a100043f0b44\",\n \"created_at\": \"2019-08-06T13:53:59.364Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-polygon\",\n \"status\": \"pending\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw a polygon for each car\",\n \"project\": \"Projectname\",\n \"priority\": 3,\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2017/02/12/21/29/false-2061132_960_720.png\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car blue\",\n \"car yelow\"\n ],\n \"min_vertices\": 4,\n \"max_vertices\": 250,\n \"userId\": null\n }\n]"}],"_postman_id":"386662a6-f0eb-414d-8b9d-55a4ba003e90"},{"name":"RETRIEVE TASK DATA BY CUSTOM FILTER","id":"8045857c-1656-4801-822d-397f42352fbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","type":"text","value":"{{user_key}}","description":"Parameter representing the key for access to requests
\n"}],"url":"{{url}}/api/task/by-custom-filter?project=Projectname&status=completed&rangeStart=2020-04-01&rangeEnd=2020-04-10&type=annotation-box&format=default","description":"Returns an object array with data of the tasks that match parameters specified in the requested fields.
\n","urlObject":{"path":["api","task","by-custom-filter"],"host":["{{url}}"],"query":[{"description":{"content":"Project Name (Optional) (String)
\n","type":"text/plain"},"key":"project","value":"Projectname"},{"description":{"content":"Task status (Optional) (ENUM(\"pending\", \"completed\", \"working\", \"cancelled\"))
\n","type":"text/plain"},"key":"status","value":"completed"},{"description":{"content":"Initial date by which you want to filter the date the task was created (Optional) (String value in \"YYYY-MM-DD\" format)
\n","type":"text/plain"},"key":"rangeStart","value":"2020-04-01"},{"description":{"content":"End date by which you want to filter the date the task was created (Optional) (String value in \"YYYY-MM-DD\" format)
\n","type":"text/plain"},"key":"rangeEnd","value":"2020-04-10"},{"description":{"content":"Type of task (Optional) (ENUM(\"annotation-point\", \"annotation-box\", \"annotation-line\", \"annotation-polygon\"))
\n","type":"text/plain"},"key":"type","value":"annotation-box"},{"description":{"content":"Output format. (Optional) (ENUM(\"default\", \"coco\", \"pascal_voc\", \"yolo\"))
\n","type":"text/plain"},"key":"format","value":"default"}],"variable":[]}},"response":[{"id":"b0efec13-35c6-4065-a2e9-ab11ea66367a","name":"RETRIVE TASK DATA BY CUSTOM FILTER","originalRequest":{"method":"GET","header":[{"key":"user_key","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkMTRjYTY3YWY2ZmYxMDAwNDJjNmI0MSIsImlhdCI6MTU2NTA5ODU0MywiZXhwIjoxNTY1MTAwMzQzfQ.xjrbmuOP1HaXcu-uZjN3qEfPJiX38-kQW4TanfYz2Ys","description":"Parameter representing the key for access to requests"}],"url":{"raw":"{{url}}/api/task/by-custom-filter?project=BOX&status=working&rangeStart=2019-01-01&rangeEnd=2019-07-30&type=annotation-box","host":["{{url}}"],"path":["api","task","by-custom-filter"],"query":[{"key":"project","value":"BOX","description":"Optional"},{"key":"status","value":"working","description":"Optional"},{"key":"rangeStart","value":"2019-01-01","description":"Optional"},{"key":"rangeEnd","value":"2019-07-30","description":"Optional"},{"key":"type","value":"annotation-box","description":"Optional"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"df998d6c-ef76-47dd-8372-2d24890cb92f"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"4222"},{"key":"Etag","value":"W/\"107e-Wy/uwugR/K3LrYg/2tlajFCR6Uk\""},{"key":"Date","value":"Tue, 06 Aug 2019 14:02:59 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"_id\": \"5d31170a488a230004a8d6f5\",\n \"key\": [],\n \"created_at\": \"2019-07-19T01:04:10.737Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"working\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw box for cars and cycles\",\n \"note\":\"Completed drawing\",\n \"project\": \"BOX\",\n \"priority\": 1,\n \"callback_url\": \"https://cdn.pixabay.com/photo/2018/08/17/10/04/traffic-3612474_960_720.jpg\",\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2018/08/17/10/04/traffic-3612474_960_720.jpg\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car\",\n \"cycle\"\n ],\n \"min_height\": 10,\n \"min_width\": 10,\n \"userId\": null,\n \"result\": {\n \"annotations\": [\n {\n \"label\": \"car\",\n \"left\": 535,\n \"top\": 388,\n \"width\": 97,\n \"height\": 69\n },\n {\n \"label\": \"car\",\n \"left\": 654,\n \"top\": 399,\n \"width\": 83,\n \"height\": 71\n },\n {\n \"label\": \"cycle\",\n \"left\": 771,\n \"top\": 405,\n \"width\": 27,\n \"height\": 53\n },\n {\n \"label\": \"cycle\",\n \"left\": 816,\n \"top\": 459,\n \"width\": 36,\n \"height\": 57\n },\n {\n \"label\": \"cycle\",\n \"left\": 840,\n \"top\": 519,\n \"width\": 41,\n \"height\": 36\n },\n {\n \"label\": \"car\",\n \"left\": 885,\n \"top\": 478,\n \"width\": 73,\n \"height\": 123\n },\n {\n \"label\": \"car\",\n \"left\": 214,\n \"top\": 532,\n \"width\": 134,\n \"height\": 104\n },\n {\n \"label\": \"car\",\n \"left\": 265,\n \"top\": 506,\n \"width\": 105,\n \"height\": 76\n }\n ]\n }\n },\n {\n \"_id\": \"5d319c26295d5900047eb4a1\",\n \"key\": [],\n \"created_at\": \"2019-07-19T10:32:06.626Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"working\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw box on cars and people\",\n \"project\": \"BOX\",\n \"priority\": 1,\n \"callback_url\": \"https://cdn.pixabay.com/photo/2016/09/02/08/32/cuba-1638594_960_720.jpg\",\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2016/09/02/08/32/cuba-1638594_960_720.jpg\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car\",\n \"people\"\n ],\n \"min_height\": 2,\n \"min_width\": 10,\n \"userId\": null,\n \"result\": {\n \"annotations\": [\n {\n \"label\": \"car\",\n \"left\": 251.0769230769231,\n \"top\": 366.2769230769231,\n \"width\": 204.8,\n \"height\": 209.72307692307692\n },\n {\n \"label\": \"people\",\n \"left\": 1.9692307692307693,\n \"top\": 410.5846153846154,\n \"width\": 60.06153846153847,\n \"height\": 139.81538461538457\n },\n {\n \"label\": \"people\",\n \"left\": 484.4307692307693,\n \"top\": 400.73846153846154,\n \"width\": 35.44615384615378,\n \"height\": 109.2923076923077\n },\n {\n \"label\": \"people\",\n \"left\": 813.2923076923078,\n \"top\": 400.73846153846154,\n \"width\": 22.64615384615388,\n \"height\": 69.90769230769234\n },\n {\n \"label\": \"people\",\n \"left\": 839.8769230769232,\n \"top\": 400.73846153846154,\n \"width\": 21.661538461538385,\n \"height\": 71.8769230769231\n },\n {\n \"label\": \"people\",\n \"left\": 871.3846153846155,\n \"top\": 397.7846153846154,\n \"width\": 24.615384615384528,\n \"height\": 67.93846153846158\n },\n {\n \"label\": \"car\",\n \"left\": 756.1846153846154,\n \"top\": 400.73846153846154,\n \"width\": 55.13846153846157,\n \"height\": 54.15384615384619\n }\n ]\n }\n },\n {\n \"_id\": \"5d31a38e295d5900047eb4a5\",\n \"key\": [],\n \"created_at\": \"2019-07-19T11:03:42.085Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"working\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw box for each car\",\n \"project\": \"BOX\",\n \"priority\": 1,\n \"callback_url\": \"https://cdn.pixabay.com/photo/2013/11/20/18/51/autos-214033_960_720.jpg\",\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2013/11/20/18/51/autos-214033_960_720.jpg\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"blue\",\n \"red\",\n \"white\",\n \"black\",\n \"green\"\n ],\n \"min_height\": 2,\n \"min_width\": 2,\n \"userId\": null,\n \"result\": {\n \"annotations\": [\n {\n \"label\": \"white\",\n \"left\": 6,\n \"top\": 130,\n \"width\": 147,\n \"height\": 94\n },\n {\n \"label\": \"blue\",\n \"left\": 294,\n \"top\": 135,\n \"width\": 98,\n \"height\": 103\n }\n ]\n }\n },\n {\n \"_id\": \"5d31ab3a295d5900047eb4aa\",\n \"key\": [],\n \"created_at\": \"2019-07-19T11:36:26.161Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"working\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw a box in a car\",\n \"project\": \"BOX\",\n \"priority\": 1,\n \"callback_url\": \"https://cdn.pixabay.com/photo/2012/02/23/09/07/traffic-15888_960_720.jpg\",\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2012/02/23/09/07/traffic-15888_960_720.jpg\",\n \"objects_to_annotate\": [],\n \"min_height\": 3,\n \"min_width\": 2,\n \"userId\": null\n },\n {\n \"_id\": \"5d31ae08295d5900047eb4ae\",\n \"key\": [],\n \"created_at\": \"2019-07-19T11:48:24.242Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"working\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw a box for each loading cart\",\n \"project\": \"BOX\",\n \"priority\": 1,\n \"callback_url\": \"https://cdn.pixabay.com/photo/2016/09/13/13/19/road-1667218_960_720.jpg\",\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2016/09/13/13/19/road-1667218_960_720.jpg\",\n \"objects_to_annotate\": [],\n \"min_height\": 2,\n \"min_width\": 4,\n \"userId\": null\n }\n ],\n \"pages\": null,\n \"total\": 5\n}"}],"_postman_id":"8045857c-1656-4801-822d-397f42352fbd"},{"name":"RETRIEVE TASK DATA BY STATUS","event":[{"listen":"prerequest","script":{"id":"4c11c631-e59a-411b-827f-2d57fe9f43a4","exec":[""],"type":"text/javascript"}}],"id":"e88a0d15-d6cb-483d-bf98-f9e8afd598b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","type":"text","value":"{{user_key}}","description":"Parameter representing the key for access to requests
\n"}],"url":"{{url}}/api/task/status/{{task_status}}","description":"Returns an object array with data of the task corresponding to requested status. Types of status that can be used are pending, completed, working, and cancelled.
Parameter representing the key for access to requests
\n"}],"url":"{{url}}/api/task/type/{{task_type}}","description":"Returns an object array with the data of the task presented by the type sent in the URL request. Types of tasks that can be used are: annotation-box, annotation-point, annotation-polygon and annotation-line.
Parameter representing the key for access to requests
\n"}],"url":"{{url}}/api/task/{{task_id}}?format=default","description":"Returns an object with data of the task requested by it's identifier.
\n","urlObject":{"path":["api","task","{{task_id}}"],"host":["{{url}}"],"query":[{"description":{"content":"Output format. (Optional) (ENUM(\"default\", \"coco\", \"pascal_voc\", \"yolo\"))
\n","type":"text/plain"},"key":"format","value":"default"}],"variable":[]}},"response":[{"id":"cd87470e-6905-4e54-905c-84d5caef4fe0","name":"RETRIVE TASK DATA BY ID","originalRequest":{"method":"GET","header":[{"key":"user_key","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkMTRjYTY3YWY2ZmYxMDAwNDJjNmI0MSIsImlhdCI6MTU2NTA5ODU0MywiZXhwIjoxNTY1MTAwMzQzfQ.xjrbmuOP1HaXcu-uZjN3qEfPJiX38-kQW4TanfYz2Ys","description":"Parameter representing the key for access to requests"}],"url":"{{url}}/api/task/5d31170a488a230004a8d6f5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"4c449007-7705-4e23-a487-d9b304fbadb2"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1064"},{"key":"Etag","value":"W/\"428-LH5YjRJ+6R9LqEJI5O6hVox3N3E\""},{"key":"Date","value":"Tue, 06 Aug 2019 13:59:42 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5d31170a488a230004a8d6f5\",\n \"created_at\": \"2019-07-19T01:04:10.737Z\",\n \"deliver_at\": \"\",\n \"type\": \"annotation-box\",\n \"status\": \"working\",\n \"callback_status\": false,\n \"completed_at\": \"\",\n \"instructions\": \"Draw box for cars and cycles\",\n \"note\":\"Completed drawing\",\n \"project\": \"BOX\",\n \"priority\": 1,\n \"attachment_url\": \"https://cdn.pixabay.com/photo/2018/08/17/10/04/traffic-3612474_960_720.jpg\",\n \"with_labels\": true,\n \"objects_to_annotate\": [\n \"car\",\n \"cycle\"\n ],\n \"min_height\": 10,\n \"min_width\": 10,\n \"userId\": null,\n \"result\": {\n \"annotations\": [\n {\n \"label\": \"car\",\n \"left\": 535,\n \"top\": 388,\n \"width\": 97,\n \"height\": 69\n },\n {\n \"label\": \"car\",\n \"left\": 654,\n \"top\": 399,\n \"width\": 83,\n \"height\": 71\n },\n {\n \"label\": \"cycle\",\n \"left\": 771,\n \"top\": 405,\n \"width\": 27,\n \"height\": 53\n },\n {\n \"label\": \"cycle\",\n \"left\": 816,\n \"top\": 459,\n \"width\": 36,\n \"height\": 57\n },\n {\n \"label\": \"cycle\",\n \"left\": 840,\n \"top\": 519,\n \"width\": 41,\n \"height\": 36\n },\n {\n \"label\": \"car\",\n \"left\": 885,\n \"top\": 478,\n \"width\": 73,\n \"height\": 123\n },\n {\n \"label\": \"car\",\n \"left\": 214,\n \"top\": 532,\n \"width\": 134,\n \"height\": 104\n },\n {\n \"label\": \"car\",\n \"left\": 265,\n \"top\": 506,\n \"width\": 105,\n \"height\": 76\n }\n ]\n }\n}"}],"_postman_id":"09eb8a60-3e7b-4e55-97d7-cbc79b362ed1"}],"id":"7e34a137-58a8-4f01-892f-c6d60f4dc0dc","description":"Each task management method returns a task object (or a list of objects in some methods) if the call succeeded.
\nParameter representing the key for access to requests
\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"roadModel","description":"Project name (Required) (String)
\n","type":"text"},{"key":"summary","value":"This project contains a dataset for road recognition in various weather conditions.","type":"text"},{"key":"instructions","value":"Mark each road by surrounding it with polygon.","type":"text"},{"key":"automatic_prelabel","value":"false","type":"text"},{"key":"automatic_label","value":"false","type":"text"}]},"url":"{{url}}/api/project","description":"Creates a new project.
\n","urlObject":{"path":["api","project"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f8675f7f-9b66-43dc-bc2e-f377504d99e2","name":"CREATE PROJECT","originalRequest":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","description":"Parameter representing the key for access to requests","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"name","value":"roadModel","description":"Project name (Required) (String)","type":"text"},{"key":"summary","value":"This project contains a dataset for road recognition in various weather conditions.","type":"text"},{"key":"instructions","value":"Mark each road by surrounding it with polygon.","type":"text"},{"key":"automatic_prelabel","value":"false","type":"text"},{"key":"automatic_label","value":"false","type":"text"}]},"url":"{{url}}/api/project"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"0d747bf2-e9d2-4625-be50-fbb7df09071f"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"390"},{"key":"Etag","value":"W/\"186-j+wYt7LD1nS/BKvsD9swpW0jCWg\""},{"key":"Date","value":"Mon, 24 May 2021 13:27:15 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"user_id\": \"60aba70ccb8af10004752d8e\",\n \"groupid\": \"60aba70ccb8af10004752d8d\",\n \"name\": \"roadModel\",\n \"summary\": \"This project contains a dataset for road recognition in various weather conditions.\",\n \"instructions\": \"Mark each road by surrounding it with polygon.\",\n \"automatic_prelabel\": false,\n \"automatic_label\": false,\n \"weightsInitialized\": false,\n \"isBeingTrained\": false,\n \"_id\": \"60aba9b3cb8af10004752da2\"\n }\n]"}],"_postman_id":"d7431285-f724-4126-86a2-5760dd288297"},{"name":"RETRIEVE PROJECTS","id":"98f43821-1ab9-45ad-9229-a9c461c5dd82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","value":"{{user_key}}","description":"Parameter representing the key for access to requests
\n","type":"text"}],"url":"{{url}}/api/project","description":"Fetches a list of projects.
\n","urlObject":{"path":["api","project"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"07f0f3dd-9f33-45b0-858a-473f7f15b18b","name":"RETRIVE PROYECTS","originalRequest":{"method":"GET","header":[{"key":"user_key","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkMTRjYTY3YWY2ZmYxMDAwNDJjNmI0MSIsImlhdCI6MTU2Nzc2MzkxMiwiZXhwIjoxNTY3ODUwMzEyfQ.oQMeWV1b4vOZq63UEpNlQW-P8DsAROWjjh5rUku5p2M","description":"Parameter representing the key for access to requests","type":"text"}],"url":"{{url}}/api/project"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"bde0c7e2-437a-420a-a12c-513f6049e875"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"145"},{"key":"Etag","value":"W/\"91-wtb+FHcxlfn75QOYA+MkYP+6Ju8\""},{"key":"Date","value":"Fri, 06 Sep 2019 18:57:08 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"_id\": \"5d723cf74ab898000434bd0a\",\n \"name\": \"Projectname\"\n },\n {\n \"_id\": \"5d72aa7e4ab898000434bd0b\",\n \"name\": \"ProjectName\"\n }\n ],\n \"pages\": null,\n \"total\": 2\n}"}],"_postman_id":"98f43821-1ab9-45ad-9229-a9c461c5dd82"},{"name":"DELETE PROJECT BY ID","id":"9b4223eb-3116-415a-8df1-6453ddaddee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"description":"Parameter representing the key for access to requests
\n","key":"user_key","type":"text","value":"{{user_key}}"}],"url":"{{url}}/api/project/{{project_id}}","description":"Deletes a project by it's identifier.
\n","urlObject":{"path":["api","project","{{project_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"01ee1a44-2018-48ff-a393-42bde98ceb75","name":"RETRIVE PROYECT BY ID","originalRequest":{"method":"DELETE","header":[{"description":"Parameter representing the key for access to requests","key":"user_key","type":"text","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkMTRjYTY3YWY2ZmYxMDAwNDJjNmI0MSIsImlhdCI6MTU2Nzc2MzkxMiwiZXhwIjoxNTY3ODUwMzEyfQ.oQMeWV1b4vOZq63UEpNlQW-P8DsAROWjjh5rUku5p2M"}],"url":"{{url}}/api/project/5d72aa7e4ab898000434bd0b"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"Cowboy"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"5f8187ef-1bce-4b8c-9540-c334c21369f4"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"55"},{"key":"Etag","value":"W/\"37-zs+dJTF9vcJ4lilPly96815whco\""},{"key":"Date","value":"Fri, 06 Sep 2019 19:03:57 GMT"},{"key":"Via","value":"1.1 vegur"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": \"5d72aa7e4ab898000434bd0b\",\n \"name\": \"ProjectName\"\n}"}],"_postman_id":"9b4223eb-3116-415a-8df1-6453ddaddee4"},{"name":"PROJECT INFERENCE","id":"12c68c0b-b4be-4bf8-a66b-dbc67b737d61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"projectId","value":"603f93d2e14bc15a0d041b2d","type":"text"},{"key":"attachmentUrl","value":"https://i.imgur.com/tOeJUpn.jpg","type":"text"}]},"url":"{{url}}/api/project/inference","description":"If you haved trained your project's model with our platform, you may use it via API.
\n","urlObject":{"path":["api","project","inference"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"47ff9fcd-345f-4dd7-b61f-035d744ab30b","name":"PROJECT INFERENCE","originalRequest":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"projectId","value":"603f93d2e14bc15a0d041b2d","type":"text"},{"key":"attachmentUrl","value":"https://i.imgur.com/tOeJUpn.jpg","type":"text"}]},"url":"{{url}}/api/project/inference"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"f550e684-e3f3-4082-8446-dbb6f026cb1a"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"114"},{"key":"ETag","value":"W/\"72-lr0QWRIadjy0hokGceQtXM30FbE\""},{"key":"Date","value":"Wed, 03 Mar 2021 15:37:09 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"result\": {\n \"result\": {\n \"0\": 0.246,\n \"1\": 0.754\n }\n },\n \"metadata\": {\n \"content_type\": \"json\",\n \"duration\": 3.143188566\n }\n}"}],"_postman_id":"12c68c0b-b4be-4bf8-a66b-dbc67b737d61"}],"id":"38fcd3d7-7b3c-45bb-8108-f0b71fb3a92e","description":"Projects are used to group tasks together. For example, you can create separate projects for annotating cars, street signs, people etc.
\nEach project management method returns a project object (or a list of objects in some methods) if the call succeeded.
\n","_postman_id":"38fcd3d7-7b3c-45bb-8108-f0b71fb3a92e"},{"name":"Managing external storage","item":[{"name":"AWS S3","item":[{"name":"SAVE S3 CREDENTIALS","id":"f8b31c69-6ad8-4641-bd63-b998710d01ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"accessKeyId","value":"{{accessKeyid}}","description":"Access key (String) (Required)
\n","type":"text"},{"key":"secretAccessKey","value":"{{secretAccessKey}}","description":"Secret access key (String) (Required)
\n","type":"text"}]},"url":"{{url}}/api/user/add-s3-credentials","description":"Saves S3 credentials and returns the ID reference of your credentials in our system.
\n","urlObject":{"path":["api","user","add-s3-credentials"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9a7e47fe-40d3-499b-891b-c5d9d8f82d7d","name":"Save S3 credentials","originalRequest":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"accessKeyId","value":"your-access-key","type":"text"},{"key":"secretAccessKey","value":"your-secret-access-key","type":"text"}]},"url":"{{url}}/api/user/add-s3-credentials"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"eefceb03-a9cc-4f7a-bd90-7b37013aa17b"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"26"},{"key":"ETag","value":"W/\"1a-+uzEfL3ox/ubThbmSBQP0ARMA94\""},{"key":"Date","value":"Fri, 23 Oct 2020 15:39:59 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"\"5f92f94f37d57f1dd00be14e\""}],"_postman_id":"f8b31c69-6ad8-4641-bd63-b998710d01ab"},{"name":"LIST S3 BUCKET","id":"aabcb667-737c-4f08-8555-f90f0f940283","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"accessKeyId","value":"{{accessKeyid}}","description":"Access key (String) (Required)
\n","type":"text"},{"key":"secretAccessKey","value":"{{secretAccessKey}}","description":"Secret access key (String) (Required)
\n","type":"text"},{"key":"bucket","value":"{{bucketName}}","description":"Bucket name (String) (Required)
\n","type":"text"},{"key":"path","value":"{{path}}","description":"Path under which all the attachments should be fetched (String) (Optional)
\n","type":"text"}]},"url":"{{url}}/api/task/list-bucket","description":"You can use this endpoint to list all the objects from your bucket and path where your attachments are stored. As an alternative, you can also use the AWS ListObjectsV2 method which is what this call uses under the hood.
\nNote: ListObjectsV2 lists up to 1000 objects, if you decide to use our endpoint, it will make recursive calls until all the attachments are fetched.
\n","urlObject":{"path":["api","task","list-bucket"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a5586286-a45e-4262-9411-575862ddff29","name":"List S3 bucket","originalRequest":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"accessKeyId","value":"{{accessKeyid}}","description":"Access key (String) (Required)","type":"text"},{"key":"secretAccessKey","value":"{{secretAccessKey}}","description":"Secret access key (String) (Required)","type":"text"},{"key":"bucket","value":"{{bucketName}}","description":"Bucket name (String) (Required)","type":"text"},{"key":"path","value":"{{path}}","description":"Path under which all the attachments should be fetched (String) (Optional)","type":"text"}]},"url":"{{url}}/api/task/list-bucket"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"51a4976d-29e5-45e6-9d49-6143e2e97446"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"349"},{"key":"ETag","value":"W/\"15d-8RJVxazDHq4cd6dMVShszME4gD8\""},{"key":"Date","value":"Fri, 23 Oct 2020 15:55:19 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Key\": \"sync-test/OUyDzS2.jpg\",\n \"LastModified\": \"2020-10-16T15:32:03.000Z\",\n \"ETag\": \"\\\"5184321f43468e382301fa44423587c3\\\"\",\n \"Size\": 328595,\n \"StorageClass\": \"STANDARD\"\n },\n {\n \"Key\": \"sync-test/traffic-jam-file-new-delhi-1004x674.jpg\",\n \"LastModified\": \"2020-10-16T14:25:16.000Z\",\n \"ETag\": \"\\\"22977d166a02a8f80c72de57c5d86aab\\\"\",\n \"Size\": 224002,\n \"StorageClass\": \"STANDARD\"\n }\n]"}],"_postman_id":"aabcb667-737c-4f08-8555-f90f0f940283"}],"id":"bf5016cf-0109-47f7-a066-6696d62b66c6","description":"If you want to create a task with AWS S3 attachment, it's a process involving 3 steps:
\nSave S3 credentials endpointList S3 bucket endpointManaging tasks and attach these two attributes to them:s3CredentialsId - matches the response from Save S3 credentials
attachment_url - you will provide the url in following syntax:\ns3+://<bucket-name>/<path-to-attachment>
So this item from trainingset.ai bucket obtained in ListObjectsV2 or List S3 bucket call:
{\n \"Key\": \"sync-test/OUyDzS2.jpg\",\n \"LastModified\": \"2020-10-16T15:32:03.000Z\",\n \"ETag\": \"\\\"5184321f43468e382301fa44423587c3\\\"\",\n \"Size\": 328595,\n \"StorageClass\": \"STANDARD\"\n}\nwould be stored as:\ns3+://trainingset.ai/sync-test/OUyDzS2.jpg
which actually corresponds to\ns3+://<bucket-name>/<Key> where the Key is attribute from ListObjectsV2 or List S3 bucket call
Note: if you are formatting the attachment_url programmatically, please make sure to URL-encode the Key attribute!!!
If you prefer to keep the attachments you store in attachment_url field fully anonymous from the outside world, you can use an external storage provider and provide us with credentials which our proxy server is going to use when an authorized user of your organization tries to access the task.
In order to add a new task from external storage, you should provide the attachment URL which will help us get the attachment from your provider.
\n","_postman_id":"cebbcc4f-a6b6-449d-a165-65f4a6fd9079"},{"name":"Managing sync","item":[{"name":"ADD SYNC","id":"1f17a2b0-41bf-4c68-b527-a88d2b301a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"syncName\": \"my-sync\",\n \"syncType\": \"s3\",\n \"syncInfo\": {\n \"credentialsId\" : \"5f7d8e8df143535363d5d3be\",\n \"path\" : \"sync-test\",\n \"bucket\" : \"trainingset.ai\"\n },\n \"instructions\": \"Instructions on how to complete the task...\",\n \"type\": \"annotation-box\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/sync/add-sync","description":"Adds a new synchronization process.
\nIt requires:
\nsyncName - name of your sync
syncType - currently can only be \"s3\"
syncInfo - provider-specific, currently only S3 is suppored which is in example below
type - one of: annotation-box, annotation-line, annotation-point, annotation-polygon, categorization-image, annotation-pcd, segmentation
Any other attributes that you want to be attached to your new task. Instructions are mandatory. These attributes are task-type specific. Please refer to the documentation of the task type you are adding to sync.
Executes the sync process.
\nIf you have added a new attachment, new task will be created.
\nIf you have deleted an attachment, task connected to it will be moved to error state.
\n","urlObject":{"path":["api","sync","execute","{{task_id}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"b3fbd71f-e83d-41db-a288-9428931c451c","name":"EXECUTE SYNC","originalRequest":{"method":"POST","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"url":"{{url}}/api/sync/execute/5f93122b9fe7c5586992fa1d"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"5882c6b6-59e8-46b9-b03c-f1013fd563e8"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"72"},{"key":"ETag","value":"W/\"48-c9M7YCJQyTB2R+Uge+9cu92qZl0\""},{"key":"Date","value":"Fri, 23 Oct 2020 17:26:13 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Added 2 tasks and moved 0 tasks to error state because they are missing."}],"_postman_id":"02170fc8-bafe-4881-964c-5b0c0805f275"},{"name":"GET SYNCS","id":"b2384824-9271-4f85-b948-382480ec7061","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"url":"{{url}}/api/sync/get-syncs","description":"Get a list of synchronizations you have created.
\n","urlObject":{"path":["api","sync","get-syncs"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7331ca01-a062-441e-91b2-9b996fdf0d82","name":"GET SYNCS","originalRequest":{"method":"GET","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"url":"{{url}}/api/sync/get-syncs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"e167f902-afd7-4e46-976d-818404b3f244"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"279"},{"key":"ETag","value":"W/\"117-noPGgJqIDCjXAs3F9Yt8zqoahI4\""},{"key":"Date","value":"Fri, 23 Oct 2020 17:30:09 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"_id\": \"5f93131b9fe7c5586992fa22\",\n \"syncName\": \"my-sync\",\n \"type\": \"s3\",\n \"info\": {\n \"credentialsId\": \"5f7d8e8df143535363d5d3be\",\n \"path\": \"sync-test\",\n \"bucket\": \"trainingset.ai\"\n },\n \"userId\": \"5f35549487e1c10d4230bfeb\",\n \"groupId\": \"5f35549487e1c10d4230bfea\",\n \"templateId\": \"5f93131b9fe7c5586992fa21\"\n }\n]"}],"_postman_id":"b2384824-9271-4f85-b948-382480ec7061"},{"name":"DELETE SYNC","id":"4f7f362d-be0c-4190-a59f-402047499408","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"url":"{{url}}/api/sync/delete-sync/5f93138c9fe7c5586992fa24?shouldDeleteTasks=false","description":"Deletes a synchronization and optionally the tasks connected to it aswell.
\n","urlObject":{"path":["api","sync","delete-sync","5f93138c9fe7c5586992fa24"],"host":["{{url}}"],"query":[{"description":{"content":"Specify whether you want to delete the tasks related to this sync too or not (Boolean) (Optional)
\n","type":"text/plain"},"key":"shouldDeleteTasks","value":"false"}],"variable":[]}},"response":[{"id":"2a996c73-8312-4ae0-b0c3-074537bd7e31","name":"DELETE SYNC","originalRequest":{"method":"DELETE","header":[{"key":"user_key","value":"{{user_key}}","type":"text"}],"url":{"raw":"{{url}}/api/sync/delete-sync/5f93138c9fe7c5586992fa24?shouldDeleteTasks=false","host":["{{url}}"],"path":["api","sync","delete-sync","5f93138c9fe7c5586992fa24"],"query":[{"key":"shouldDeleteTasks","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept, Authorization, user, admin_secret"},{"key":"X-Request-Id","value":"4bf6554e-7044-4160-ab2e-94f8a0e49473"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"34"},{"key":"ETag","value":"W/\"22-lhT6XtNJ85G5t2OinL/8v+lBgtI\""},{"key":"Date","value":"Fri, 23 Oct 2020 17:32:01 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"Deleted 1 sync records and 0 tasks"}],"_postman_id":"4f7f362d-be0c-4190-a59f-402047499408"}],"id":"13ea54f4-70d5-4f71-91a6-e706e5652113","description":"Synchronizations are used to keep data in sync between your storage provider and Trainingset's tasks.
\nIf you add a new attachment, new task will be created.
\nIf you delete an attachment, task will be moved to error state.