{"info":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","description":"

Introduction

\n

The Alphacast API allows to programmatically create repository, datasets and upload & download data from each dataset. Permissions are verified in each action, so every request is authenticated.

\n

Authentication

\n

The API currently works with Basic Authentication, using an api_key as username, and leaving the password empty. api_keys are provided in the settings section in the Alphacast website.

\n

Error Codes

\n

The API would responde error code such as 404, 401 following the HTTP spec for different scenarios. Data download may also responde with 302 redirect urls, indicating where the data is allocated for fastest download.

\n

Rate limit

\n

The API currently limits files to 50MB.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"17184186","collectionId":"60868e70-edda-4dec-a5f9-d8c5407cbf87","publishedId":"TzzDLb94","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"6640E9"},"publishDate":"2021-08-25T12:05:42.000Z"},"item":[{"name":"Get Repositories","id":"dabb172e-4b86-4cb5-836f-bb9d279534d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{host}}/repositories","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["repositories"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dabb172e-4b86-4cb5-836f-bb9d279534d6"},{"name":"Get Datasets","id":"d86435c7-521c-45e2-b7b6-cc583ca3ea52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/datasets","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d86435c7-521c-45e2-b7b6-cc583ca3ea52"},{"name":"Post Repository","id":"59d52bd9-fd21-445e-b183-84ce7432fb3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\": \"test2\", \"privacy\": \"Private\"}","options":{"raw":{"language":"json"}}},"url":"{{host}}/repositories","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["repositories"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"59d52bd9-fd21-445e-b183-84ce7432fb3f"},{"name":"Post Pipeline","id":"1e6d117b-2ebd-4c45-b1c1-39433cbb4cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\": \"test2\", \"privacy\": \"Private\"}","options":{"raw":{"language":"json"}}},"url":"{{host}}/repositories","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["repositories"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1e6d117b-2ebd-4c45-b1c1-39433cbb4cbf"},{"name":"Post Dataset","id":"8a620d72-ef74-4665-88cd-2fb9c7e63482","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\"name\": \"test pipeline seriese\", \"repositoryId\": 397}","options":{"raw":{"language":"json"}}},"url":"{{host}}/datasets","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8a620d72-ef74-4665-88cd-2fb9c7e63482"},{"name":"Delete Repository","id":"49b0c511-ba14-44c6-984f-8c76774bb2c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{host}}/repositories/2","urlObject":{"path":["repositories","2"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49b0c511-ba14-44c6-984f-8c76774bb2c8"},{"name":"Delete Dataset","id":"b0913939-418e-4f02-a051-4bb472b15b7e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"api.alphacast.io/datasets/15406","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","15406"],"host":["api","alphacast","io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b0913939-418e-4f02-a051-4bb472b15b7e"},{"name":"Get Single Repository","id":"fb681bca-0675-4c59-9d41-c62e3b4374f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{host}}/repositories/65","urlObject":{"path":["repositories","65"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb681bca-0675-4c59-9d41-c62e3b4374f5"},{"name":"Get Single Dataset","id":"60b5af71-8cdc-41e9-8387-1254f7ab9652","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/datasets/22","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","22"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"60b5af71-8cdc-41e9-8387-1254f7ab9652"},{"name":"Update Repository","id":"67358fb0-25f6-4b8f-8b34-72aede08d4d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"name\": \"updated\"}","options":{"raw":{"language":"json"}}},"url":"{{host}}/repositories/1","urlObject":{"path":["repositories","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"67358fb0-25f6-4b8f-8b34-72aede08d4d1"},{"name":"Update Dataset","id":"cabbdff5-7c4d-4dd2-927b-3879013d685b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\"name\": \"updated\"}","options":{"raw":{"language":"json"}}},"url":"{{host}}/datasets/6280","urlObject":{"path":["datasets","6280"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cabbdff5-7c4d-4dd2-927b-3879013d685b"},{"name":"Get Single Process","id":"d13532fe-eb33-41af-b208-4cd950386871","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/datasets/23/processes/702","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","23","processes","702"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d13532fe-eb33-41af-b208-4cd950386871"},{"name":"Initialize Dataset Columns","id":"cee2edfd-c94a-4103-b116-89da70372be3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[{\"sourceName\": \"Date\", \"isEntity\": \"True\", \"dataType\": \"Date\"}]","options":{"raw":{"language":"json"}}},"url":"localhost:5000/datasets/8164/columns","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"port":"5000","path":["datasets","8164","columns"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"cee2edfd-c94a-4103-b116-89da70372be3"},{"name":"Get DataValues","id":"ffced30f-3d88-4538-97d9-ccb06bb30efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/datasets/6701/data","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","6701","data"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ffced30f-3d88-4538-97d9-ccb06bb30efd"},{"name":"Upload Data","id":"d6e97a3e-4467-4767-8ef2-1b2e577d71b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"formdata","formdata":[{"key":"data","type":"file","src":"/Users/miguelsaez/Downloads/22.csv"},{"key":"data","value":"","type":"text","disabled":true}]},"url":"{{host}}/datasets/22/data?deleteMissingFromDB=True&onConflictUpdateDB=True","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","22","data"],"host":["{{host}}"],"query":[{"key":"deleteMissingFromDB","value":"True"},{"key":"onConflictUpdateDB","value":"True"},{"disabled":true,"key":"data","value":null}],"variable":[]}},"response":[],"_postman_id":"d6e97a3e-4467-4767-8ef2-1b2e577d71b2"},{"name":"Get Processes","id":"2c1ff21e-bf93-466f-9f70-44b84e65523e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/datasets/22/processes","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","22","processes"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c1ff21e-bf93-466f-9f70-44b84e65523e"},{"name":"Get Single Dataset Date stats","id":"2e1446a7-bd69-4231-8f4f-d610a32830ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host}}/datasets/6263/date-stats","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","6263","date-stats"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2e1446a7-bd69-4231-8f4f-d610a32830ef"},{"name":"Put Dataset Columns","id":"be72378a-9788-415d-9956-21b0595f7fe5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[{\"sourceName\": \"Date\", \"isEntity\": true, \"dataType\": \"Date\", \"destinationName\": \"Date\"}]","options":{"raw":{"language":"json"}}},"url":"{{host}}/datasets/8164/columns","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]},"isInherited":true,"source":{"_postman_id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","id":"60868e70-edda-4dec-a5f9-d8c5407cbf87","name":"Alphacast","type":"collection"}},"urlObject":{"path":["datasets","8164","columns"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"be72378a-9788-415d-9956-21b0595f7fe5"}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{apiKey}}"}]}},"event":[{"listen":"prerequest","script":{"id":"6eb1f097-0f8c-45ad-af2f-7afbc7d2e9d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"10a7224f-d421-4ce1-8ed1-d819783e2785","type":"text/javascript","exec":[""]}}],"variable":[{"value":""},{"value":""},{"value":""},{"value":""}]}