{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/search-tools:visagecloud/get-account-by-access-key-using-get":{"get":{"operationId":"search_tools_visagecloud_get_account_by_access_key_using_get","summary":"Get account information by accessKey and secretKey","description":"GET /rest/v1.1/account/account","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"accessKey","schema":{"type":"string","description":"accessKey"}},{"name":"secretKey","in":"query","required":true,"description":"secretKey","schema":{"type":"string","description":"secretKey"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-billing-per-account-using-get":{"get":{"operationId":"search_tools_visagecloud_get_billing_per_account_using_get","summary":"Get billing information by accessKey and secretKey","description":"GET /rest/v1.1/account/billing","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"accessKey","schema":{"type":"string","description":"accessKey"}},{"name":"secretKey","in":"query","required":true,"description":"secretKey","schema":{"type":"string","description":"secretKey"}},{"name":"startDateTime","in":"query","required":false,"description":"startDateTime","schema":{"type":"string","description":"startDateTime"}},{"name":"endDateTime","in":"query","required":false,"description":"endDateTime","schema":{"type":"string","description":"endDateTime"}},{"name":"dateTemplate","in":"query","required":false,"description":"dateTemplate","schema":{"type":"string","description":"dateTemplate"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/change-password-using-post":{"post":{"operationId":"search_tools_visagecloud_change_password_using_post","summary":"Change password for an account using old password","description":"POST /rest/v1.1/account/changePassword","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","oldPassword","newPassword"],"properties":{"email":{"type":"string","description":"email"},"oldPassword":{"type":"string","description":"oldPassword"},"newPassword":{"type":"string","description":"newPassword"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/login-with-email-using-post":{"post":{"operationId":"search_tools_visagecloud_login_with_email_using_post","summary":"Get account information including accessKey and secretKey by email and password","description":"POST /rest/v1.1/account/login","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","description":"email"},"password":{"type":"string","description":"password"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/compare-faces-using-get":{"get":{"operationId":"search_tools_visagecloud_compare_faces_using_get","summary":"Compare several faces identified by faceHash, without depending on mapping faces to profiles","description":"GET /rest/v1.1/analysis/compare","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"faceHashes","in":"query","required":true,"description":"The IDs of the faces which you want compared, comma-separated","schema":{"type":"array","description":"The IDs of the faces which you want compared, comma-separated"}},{"name":"showDetails","in":"query","required":false,"description":"Show details","schema":{"type":"boolean","default":false,"description":"Show details"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/perform-analysis-using-post":{"post":{"operationId":"search_tools_visagecloud_perform_analysis_using_post","summary":"Perform detection on a given picture or picture URL","description":"POST /rest/v1.1/analysis/detection","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"storeAnalysisPicture":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the picture of the analysis to be stored for later retrieval"},"storeFacePictures":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the faces inside the picture to be stored for later retrieval"},"storeResult":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the result of the analysis to be stored"},"retentionTime":{"type":"integer","description":"How many seconds the results should be retained in stoarage?"},"pictureURL":{"type":"string","description":"The URL of the picture, assuming it is served by a third party server. Server should be accesible from the Internet or through another…"},"algorithmVersion":{"type":"string","enum":["V1","V2"],"default":"V2","description":"Algorithm version (V2 is more performant but not backward compatible)"},"autoRotate":{"type":"boolean","default":false,"description":"Auto-rotate to find flipped or rotate faces"},"skipEXIF":{"type":"boolean","default":false,"description":"Skip EXIF rotation procesing"},"waitForPictureUpload":{"type":"boolean","default":false,"description":"Waits until the picture is successfully uploaded, before returning the response back the the client"},"filters":{"type":"array","description":"[For advanced users only] Change feature filters for robustness of feature extraction. Tweaking this parameter may affect per"},"options":{"type":"string","description":"[For advanced users only] Options for preprocessing of image."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/retrive-latest-using-get":{"get":{"operationId":"search_tools_visagecloud_retrive_latest_using_get","summary":"Retrieve the last *count* operations per current account","description":"GET /rest/v1.1/analysis/listLatest","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"count","in":"query","required":false,"description":"How many records to retrieve at a time","schema":{"type":"integer","default":100,"description":"How many records to retrieve at a time"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/perform-recognition-using-post":{"post":{"operationId":"search_tools_visagecloud_perform_recognition_using_post","summary":"Perform labeled recognition on a given picture or picture URL","description":"POST /rest/v1.1/analysis/recognition","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","collectionId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"storeAnalysisPicture":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the picture of the analysis to be stored for later retrieval"},"storeFacePictures":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the faces inside the picture to be stored for later retrieval"},"storeResult":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the result of the analysis to be stored"},"retentionTime":{"type":"integer","description":"How many seconds the results should be retained in stoarage?"},"collectionId":{"type":"string","description":"Uniquely identified collection that can store multiple profiles"},"labels":{"type":"array","description":"Labels associated with the given picture or picture URL"},"attributeFilters":{"type":"array","enum":["NO_FILTER","GENDER_FILTER","AGE_GROUP_FILTER"],"description":"Filters that will be applied on the recognition operation"},"pictureURL":{"type":"string","description":"The URL of the picture"},"algorithmVersion":{"type":"string","enum":["V1","V2"],"default":"V2","description":"Algorithm version (V2 is more performant but not backward compatible)"},"autoRotate":{"type":"boolean","default":false,"description":"Auto-rotate to find flipped or rotate faces"},"skipEXIF rotation processing":{"type":"boolean","default":false,"description":"Skip EXIF rotation procesing"},"waitForPictureUpload":{"type":"boolean","default":false,"description":"Waits until the picture is successfully uploaded, before returning the response back the the client"},"filters":{"type":"array","description":"[For advanced users only] Change feature filters for robustness of feature extraction. Tweaking this parameter may affect per"},"options":{"type":"string","description":"[For advanced users only] Options for preprocessing of image."},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/retrieve-analysis-using-get":{"get":{"operationId":"search_tools_visagecloud_retrieve_analysis_using_get","summary":"Retrieve a complete analysis object including both detection and recognition information","description":"GET /rest/v1.1/analysis/retrieve","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"analysisId","in":"query","required":true,"description":"The ID of the analysis for which the data will be retrieved","schema":{"type":"string","description":"The ID of the analysis for which the data will be retrieved"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/counter-using-post":{"post":{"operationId":"search_tools_visagecloud_counter_using_post","summary":"Count individuals in streams or collections","description":"POST /rest/v1.1/analytics/counting","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"collectionIds":{"type":"array","description":"Collection ids"},"streamIds":{"type":"array","description":"Stream Ids"},"startDateTime":{"type":"string","description":"startDateTime"},"endDateTime":{"type":"string","description":"endDateTime"},"visitDuration":{"type":"integer","default":3600000,"description":"visitDuration"},"maxIterations":{"type":"integer","default":1,"description":"maxIterations"},"maxBatchIterations":{"type":"integer","default":1,"description":"maxBatchIterations"},"minNeighborsMergedPerIteration":{"type":"integer","default":5,"description":"minNeighborsMergedPerIteration"},"mergingStep":{"type":"number","default":1,"description":"mergingStep"},"shuffling":{"type":"boolean","default":false,"description":"shuffling"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/presence-timeseries-using-post":{"post":{"operationId":"search_tools_visagecloud_presence_timeseries_using_post","summary":"Show audience (based on number of occurrences of each person) breakdown per declared attribute (age, gender).","description":"POST /rest/v1.1/analytics/presence/timeseries","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","attributes"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"streamIds":{"type":"array","description":"Stream Ids"},"startDateTime":{"type":"string","description":"startDateTime"},"endDateTime":{"type":"string","description":"endDateTime"},"step":{"type":"integer","default":3600,"description":"step"},"attributes":{"type":"array","description":"attributes"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/presence-total-using-post":{"post":{"operationId":"search_tools_visagecloud_presence_total_using_post","summary":"Show presence (based on number of occurences of each face) breakdown per declared attribute (age, gender)","description":"POST /rest/v1.1/analytics/presence/total","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","streamIds","attributes"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"streamIds":{"type":"array","description":"Stream Ids"},"startDateTime":{"type":"string","description":"startDateTime"},"endDateTime":{"type":"string","description":"endDateTime"},"attributes":{"type":"array","description":"attributes"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-classifer-full-using-get":{"get":{"operationId":"search_tools_visagecloud_get_classifer_full_using_get","summary":"Get classifier full","description":"GET /rest/v1.1/classifier/svm","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"id","in":"query","required":true,"description":"The id of the classifier that you want the status for","schema":{"type":"string","description":"The id of the classifier that you want the status for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/add-svmclassifier-using-post":{"post":{"operationId":"search_tools_visagecloud_add_svmclassifier_using_post","summary":"Create new SVM classifier with given name","description":"POST /rest/v1.1/classifier/svm","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","name","collectionIds","classificationAttributeName"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"name":{"type":"string","description":"The name of the SVM classifier that will be created"},"collectionIds":{"type":"array","description":"Collection ids"},"preprocessor":{"type":"string","default":"FeaturePreprocessor","description":"Preprocessor"},"classificationAttributeName":{"type":"string","description":"Classification attribute name"},"considerViewPoints":{"type":"boolean","default":false,"description":"Consider view point"},"seed":{"type":"integer","default":179425537,"description":"Seed for divididing training and evaluation sets"},"trainingRatio":{"type":"number","default":0.8,"description":"Training ratio"},"probabilityParameter":{"type":"integer","default":1,"description":"Probability parameter"},"gammaParameter":{"type":"number","default":0.5,"description":"Gamma parameter"},"nuParameter":{"type":"number","default":0.25,"description":"Nu parameter"},"cParameter":{"type":"number","default":1,"description":"c parameter"},"svmTypeParameter":{"type":"integer","default":0,"description":"SVM type parameter"},"kernelTypeParameter":{"type":"integer","default":0,"description":"Kernel type parameter"},"cacheSizeParameter":{"type":"number","default":500,"description":"Cache size parameter"},"epsParameter":{"type":"number","default":0.001,"description":"Eps parameter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/remove-classifer-using-delete":{"post":{"operationId":"search_tools_visagecloud_remove_classifer_using_delete","summary":"Delete existing classifier","description":"DELETE /rest/v1.1/classifier/svm","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","id"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"id":{"type":"string","description":"The id of the classifier that will be removed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-classifer-status-using-get":{"get":{"operationId":"search_tools_visagecloud_get_classifer_status_using_get","summary":"Get classifer status","description":"GET /rest/v1.1/classifier/svm/status","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"id","in":"query","required":true,"description":"The id of the classifier that you want the status for","schema":{"type":"string","description":"The id of the classifier that you want the status for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-all-collections-using-get":{"get":{"operationId":"search_tools_visagecloud_get_all_collections_using_get","summary":"Retrieve all collections","description":"GET /rest/v1.1/collection/","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/add-collection-using-post":{"post":{"operationId":"search_tools_visagecloud_add_collection_using_post","summary":"Create new empty collection with given name","description":"POST /rest/v1.1/collection/","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/export-csvusing-get":{"get":{"operationId":"search_tools_visagecloud_export_csvusing_get","summary":"Retrieve collection content for data analysis.","description":"GET /rest/v1.1/collection/export/csv","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"collectionId","in":"query","required":true,"description":"The id of the collection for which the data will be retrieved","schema":{"type":"string","description":"The id of the collection for which the data will be retrieved"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-collection-using-get":{"get":{"operationId":"search_tools_visagecloud_get_collection_using_get","summary":"Retrieve existing collection content","description":"GET /rest/v1.1/collection/{id}","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"id","in":"query","required":true,"description":"The id of the collection for which the data will be retrieved","schema":{"type":"string","description":"The id of the collection for which the data will be retrieved"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/update-collection-using-patch":{"post":{"operationId":"search_tools_visagecloud_update_collection_using_patch","summary":"Update an existing collection with a given id","description":"PATCH /rest/v1.1/collection/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","id"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"name":{"type":"string","description":"The name of the collection that will be updated"},"purposes":{"type":"array","enum":["FEATURES","LANDMARKS","ATTRIBUTES"],"description":"The newly declared purposes of the collection"},"id":{"type":"string","description":"The id of the collection that will be updated"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/delete-collection-using-delete":{"post":{"operationId":"search_tools_visagecloud_delete_collection_using_delete","summary":"Delete existing collection with associated profiles and faces.","description":"DELETE /rest/v1.1/collection/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","id"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"id":{"type":"string","description":"The id of the collection that will be removed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-all-collection-profiles-using-get":{"get":{"operationId":"search_tools_visagecloud_get_all_collection_profiles_using_get","summary":"Gets all the profiles associated to a collection","description":"GET /rest/v1.1/collection/{id}/profile","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"id","in":"query","required":true,"description":"The collection that contains the profile","schema":{"type":"string","description":"The collection that contains the profile"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-profile-enrollment-status-using-get":{"get":{"operationId":"search_tools_visagecloud_get_profile_enrollment_status_using_get","summary":"Gets the enrollment status of a profile: information on whether it is suitable for authentication.","description":"GET /rest/v1.1/profile/enrollmentStatus","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"profileId","in":"query","required":true,"description":"The profile that contains the faces","schema":{"type":"string","description":"The profile that contains the faces"}},{"name":"collectionId","in":"query","required":true,"description":"The collection that contains the profile","schema":{"type":"string","description":"The collection that contains the profile"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-faces-from-profile-using-get":{"get":{"operationId":"search_tools_visagecloud_get_faces_from_profile_using_get","summary":"Gets all the faceHashes associated to a profile","description":"GET /rest/v1.1/profile/map","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"profileId","in":"query","required":true,"description":"The profile that contains the faces","schema":{"type":"string","description":"The profile that contains the faces"}},{"name":"collectionId","in":"query","required":true,"description":"The collection that contains the profile","schema":{"type":"string","description":"The collection that contains the profile"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/map-faces-to-profile-using-post":{"post":{"operationId":"search_tools_visagecloud_map_faces_to_profile_using_post","summary":"Adds (maps) a list of faces, identified by faceHashes, to a profile, identified by profileId","description":"POST /rest/v1.1/profile/map","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","faceHashes","profileId","collectionId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"faceHashes":{"type":"string","description":"Comma separated face hashes, that will be associated to a profile"},"profileId":{"type":"string","description":"The profile that will store the face"},"collectionId":{"type":"string","description":"The collection that contains the profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/remove-faces-from-profile-using-delete":{"post":{"operationId":"search_tools_visagecloud_remove_faces_from_profile_using_delete","summary":"Removes (unmaps) a list of faces, identified by faceHashes, from a profile, identified by profileId","description":"DELETE /rest/v1.1/profile/map","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","faceHashes","profileId","collectionId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"faceHashes":{"type":"string","description":"Comma separated face hashes, that will be removed from a profile"},"profileId":{"type":"string","description":"The profile that contains the face"},"collectionId":{"type":"string","description":"The collection that contains the profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/add-profile-using-post":{"post":{"operationId":"search_tools_visagecloud_add_profile_using_post","summary":"Creates a new profile with no faces associated to it (empty profile)","description":"POST /rest/v1.1/profile/profile","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","collectionId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"collectionId":{"type":"string","description":"Uniquely identified collection that can store multiple profiles"},"externalId":{"type":"string","description":"External reference to additional information you don’t want to share with VisageCloud"},"screenName":{"type":"string","description":"Human-readable label for the profile"},"labels":{"type":"array","description":"Allows you to do finer filtering in face recognition"},"classificationAttributes":{"type":"string","description":"Comma separated key:value classification attributes"},"details":{"type":"string","description":"Comma separated key:value details of profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-profile-using-get":{"get":{"operationId":"search_tools_visagecloud_get_profile_using_get","summary":"Retrieves a profile","description":"GET /rest/v1.1/profile/{id}","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"collectionId","in":"query","required":true,"description":"Uniquely identified collection that can store multiple profiles","schema":{"type":"string","description":"Uniquely identified collection that can store multiple profiles"}},{"name":"withFaces","in":"query","required":false,"description":"Retrieves the profile with all its associated faces","schema":{"type":"string","default":"false","description":"Retrieves the profile with all its associated faces"}},{"name":"id","in":"query","required":true,"description":"The profile id (provide this if you don't have the externalId","schema":{"type":"string","description":"The profile id (provide this if you don't have the externalId"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/update-profile-using-patch":{"post":{"operationId":"search_tools_visagecloud_update_profile_using_patch","summary":"Update an existing profile with a given id","description":"PATCH /rest/v1.1/profile/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","id","collectionId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"},"id":{"type":"string","description":"The id of the profile that will be updated"},"collectionId":{"type":"string","description":"Uniquely identified collection that can store multiple profiles"},"externalId":{"type":"string","description":"External reference to additional information you don’t want to share with VisageCloud"},"screenName":{"type":"string","description":"Human-readable label for the profile"},"labels":{"type":"array","description":"Allows you to do finer filtering in face recognition"},"classificationAttributes":{"type":"string","description":"Comma separated key:value classification attributes"},"details":{"type":"string","description":"Comma separated key:value details of profile"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/delete-profile-using-delete":{"post":{"operationId":"search_tools_visagecloud_delete_profile_using_delete","summary":"Deletes a profile and unmaps all its faces","description":"DELETE /rest/v1.1/profile/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","collectionId","id"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"collectionId":{"type":"string","description":"Uniquely identified collection that can store multiple profiles"},"id":{"type":"string","description":"The profile id (provide this if you don't have the externalId"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/streams-by-account-using-get":{"get":{"operationId":"search_tools_visagecloud_streams_by_account_using_get","summary":"Show status of all streams from account","description":"GET /rest/v1.1/stream/all","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-last-nattedance-using-get":{"get":{"operationId":"search_tools_visagecloud_get_last_nattedance_using_get","summary":"Get last N recognized individuals from stream","description":"GET /rest/v1.1/stream/attendance","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"streamIds","in":"query","required":false,"description":"The id of the stream for which the frames will be retrieved","schema":{"type":"array","description":"The id of the stream for which the frames will be retrieved"}},{"name":"count","in":"query","required":false,"description":"How many frames to retrieve at a time","schema":{"type":"integer","default":10,"description":"How many frames to retrieve at a time"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/cleanup-stream-using-patch":{"post":{"operationId":"search_tools_visagecloud_cleanup_stream_using_patch","summary":"Cleanup frames older than specified timeframe","description":"PATCH /rest/v1.1/stream/cleanup","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","streamId","interval"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"streamId":{"type":"string","description":"The id of the stream that will be stopped"},"interval":{"type":"integer","description":"Frames older than interval (seconds) will be cleaned up"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-frame-image-using-get":{"get":{"operationId":"search_tools_visagecloud_get_frame_image_using_get","summary":"Get individual frame image","description":"GET /rest/v1.1/stream/frameImage","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"streamId","in":"query","required":true,"description":"The id of the stream for which the frames will be retrieved","schema":{"type":"string","description":"The id of the stream for which the frames will be retrieved"}},{"name":"timestamp","in":"query","required":true,"description":"Timestamp of frame to retrieve","schema":{"type":"integer","description":"Timestamp of frame to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-last-nframes-using-get":{"get":{"operationId":"search_tools_visagecloud_get_last_nframes_using_get","summary":"Get last processed N frames from stream","description":"GET /rest/v1.1/stream/frames","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey or readOnlyKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey or readOnlyKey provided by VisageCloud"}},{"name":"streamId","in":"query","required":true,"description":"The id of the stream for which the frames will be retrieved","schema":{"type":"string","description":"The id of the stream for which the frames will be retrieved"}},{"name":"count","in":"query","required":false,"description":"How many frames to retrieve at a time","schema":{"type":"integer","default":10,"description":"How many frames to retrieve at a time"}},{"name":"collectionId","in":"query","required":false,"description":"The collection id you want to run recognition against","schema":{"type":"string","description":"The collection id you want to run recognition against"}},{"name":"labels","in":"query","required":false,"description":"Labels associated with the given picture or picture URL","schema":{"type":"array","description":"Labels associated with the given picture or picture URL"}},{"name":"attributeFilters","in":"query","required":false,"description":"Filters that will be applied on the recognition operation","schema":{"type":"array","enum":["NO_FILTER","GENDER_FILTER","AGE_GROUP_FILTER"],"description":"Filters that will be applied on the recognition operation"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/start-stream-using-patch":{"post":{"operationId":"search_tools_visagecloud_start_stream_using_patch","summary":"Start existing stream","description":"PATCH /rest/v1.1/stream/start","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","streamId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"streamId":{"type":"string","description":"The id of the stream that will be started"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/stop-stream-using-patch":{"post":{"operationId":"search_tools_visagecloud_stop_stream_using_patch","summary":"Stop existing stream","description":"PATCH /rest/v1.1/stream/stop","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","streamId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"streamId":{"type":"string","description":"The id of the stream that will be stopped"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/add-stream-using-post":{"post":{"operationId":"search_tools_visagecloud_add_stream_using_post","summary":"Create new stream with given name","description":"POST /rest/v1.1/stream/stream","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","name","url"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"name":{"type":"string","description":"The name of the stream that will be created"},"url":{"type":"string","description":"The url of the stream"},"method":{"type":"string","enum":["WEBRTC_PULL","WEBRTC_PUSH","INGESTION_ENDPOINT"],"default":"WEBRTC_PUSH","description":"Streaming method"},"username":{"type":"string","description":"Username"},"password":{"type":"string","description":"Password"},"skipFramesWithNoFaces":{"type":"boolean","default":true,"description":"Boolean value indicating whether you want the original picture to be stored for later retrieval"},"retentionTime":{"type":"integer","default":605000,"description":"Number of seconds for frames to be kept. Default is 605000s (7 days)"},"storeOriginalFrames":{"type":"boolean","default":false,"description":"Boolean value indicating whether you want the original picture to be stored for later retrieval"},"storeAttendanceFaces":{"type":"boolean","default":false,"description":"Boolean value indicating whether you want to store permanently store faces clippings of the recognized faces"},"storeAttendanceFrames":{"type":"boolean","default":false,"description":"Boolean value indicating whether you want to store permanently store frames with a recognized face in them"},"isActive":{"type":"boolean","default":false,"description":"Boolean value indicating whether the stream is currently active or not"},"associatedCollections":{"type":"array","description":"List of collection ids which will be used to measure attendance"},"attributes":{"type":"string","description":"Attributes of the stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/remove-stream-using-delete":{"post":{"operationId":"search_tools_visagecloud_remove_stream_using_delete","summary":"Delete existing stream","description":"DELETE /rest/v1.1/stream/{id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","id"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"id":{"type":"string","description":"The id of the stream that will be removed"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/get-stream-using-get":{"get":{"operationId":"search_tools_visagecloud_get_stream_using_get","summary":"Get an existing stream with a given ID","description":"GET /rest/v1.1/stream/{streamId}","tags":["search-tools"],"parameters":[{"name":"accessKey","in":"query","required":true,"description":"The accessKey provided by VisageCloud","schema":{"type":"string","description":"The accessKey provided by VisageCloud"}},{"name":"secretKey","in":"query","required":true,"description":"The secretKey provided by VisageCloud","schema":{"type":"string","description":"The secretKey provided by VisageCloud"}},{"name":"streamId","in":"query","required":true,"description":"The id of the stream for which the data will be retrieved","schema":{"type":"string","description":"The id of the stream for which the data will be retrieved"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/search-tools:visagecloud/update-stream-using-patch":{"post":{"operationId":"search_tools_visagecloud_update_stream_using_patch","summary":"Update an existing stream with a given ID","description":"PATCH /rest/v1.1/stream/{streamId}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["accessKey","secretKey","streamId"],"properties":{"accessKey":{"type":"string","description":"The accessKey provided by VisageCloud"},"secretKey":{"type":"string","description":"The secretKey provided by VisageCloud"},"streamId":{"type":"string","description":"The id of the stream that will be updated"},"name":{"type":"string","description":"The name of the stream that will be updated"},"url":{"type":"string","description":"The url of the stream"},"method":{"type":"string","enum":["WEBRTC_PULL","WEBRTC_PUSH","INGESTION_ENDPOINT"],"description":"Streaming method"},"username":{"type":"string","description":"Username"},"password":{"type":"string","description":"Password"},"skipFramesWithNoFaces":{"type":"boolean","description":"Boolean value indicating whether you want the original picture to be stored for later retrieval"},"retentionTime":{"type":"integer","description":"Number of seconds for frames to be kept"},"storeOriginalFrames":{"type":"boolean","description":"Boolean value indicating whether you want the original picture to be stored for later retrieval"},"storeAttendanceFaces":{"type":"boolean","description":"Boolean value indicating whether you want to store permanently store faces clippings of the recognized faces"},"storeAttendanceFrames":{"type":"boolean","description":"Boolean value indicating whether you want to store permanently store frames with a recognized face in them"},"isActive":{"type":"boolean","description":"Boolean value indicating whether the stream is currently active or not"},"associatedCollections":{"type":"array","description":"List of collection ids which will be used to measure attendance"},"attributes":{"type":"string","description":"Attributes of the stream"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}