---
swagger: "2.0"
x-collection-name: Visage Cloud
x-complete: 0
info:
  title: Visage Cloud Delete existing stream
  description: ""
  termsOfService: https://visagecloud.com/terms-of-use
  contact:
    name: VisageCloud
    url: https://visagecloud.com
    email: office@visagecloud.com
  version: "1.1"
host: visagecloud.com
basePath: /
schemes:
- http
produces:
- application/json
consumes:
- application/json
paths:
  /rest/v1.1/account/account:
    get:
      summary: Get account information by accessKey and secretKey
      description: ""
      operationId: getAccountByAccessKeyUsingGET
      x-api-path-slug: restv1-1accountaccount-get
      parameters:
      - in: query
        name: accessKey
        description: accessKey
      - in: query
        name: secretKey
        description: secretKey
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/account/billing:
    get:
      summary: Get billing information by accessKey and secretKey
      description: ""
      operationId: getBillingPerAccountUsingGET
      x-api-path-slug: restv1-1accountbilling-get
      parameters:
      - in: query
        name: accessKey
        description: accessKey
      - in: query
        name: dateTemplate
        description: dateTemplate
      - in: query
        name: endDateTime
        description: endDateTime
      - in: query
        name: secretKey
        description: secretKey
      - in: query
        name: startDateTime
        description: startDateTime
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/account/changePassword:
    post:
      summary: Change password for an account using old password
      description: ""
      operationId: changePasswordUsingPOST
      x-api-path-slug: restv1-1accountchangepassword-post
      parameters:
      - in: query
        name: email
        description: email
      - in: query
        name: newPassword
        description: newPassword
      - in: query
        name: oldPassword
        description: oldPassword
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/account/login:
    post:
      summary: Get account information including accessKey and secretKey by email
        and password
      description: ""
      operationId: loginWithEmailUsingPOST
      x-api-path-slug: restv1-1accountlogin-post
      parameters:
      - in: query
        name: email
        description: email
      - in: query
        name: password
        description: password
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analysis/compare:
    get:
      summary: Compare several faces identified by faceHash, without depending on
        mapping faces to profiles
      description: ""
      operationId: compareFacesUsingGET
      x-api-path-slug: restv1-1analysiscompare-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: faceHashes
        description: The IDs of the faces which you want compared, comma-separated
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: showDetails
        description: Show details
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analysis/detection:
    post:
      summary: Perform detection on a given picture or picture URL
      description: ""
      operationId: performAnalysisUsingPOST
      x-api-path-slug: restv1-1analysisdetection-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: algorithmVersion
        description: Algorithm version (V2 is more performant but not backward compatible)
      - in: query
        name: filters
        description: '[For advanced users only] Change feature filters for robustness
          of feature extraction'
      - in: query
        name: options
        description: '[For advanced users only] Options for preprocessing of image'
      - in: formData
        name: picture
        description: The multipart/form-data version of the image, in case a direct
          upload is used
      - in: query
        name: pictureURL
        description: The URL of the picture, assuming it is served by a third party
          server
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: skipEXIF
        description: Skip EXIF rotation procesing
      - in: query
        name: storeAnalysisPicture
        description: Boolean value indicating whether you want the picture of the
          analysis to be stored for later retrieval
      - in: query
        name: storeFacePictures
        description: Boolean value indicating whether you want the faces inside the
          picture to be stored for later retrieval
      - in: query
        name: storePicture
        description: Boolean value indicating whether you want the original picture
          to be stored for later retrieval
      - in: query
        name: storeResult
        description: Boolean value indicating whether you want the result of the analysis
          to be stored
      - in: query
        name: waitForPictureUpload
        description: Waits until the picture is successfully uploaded, before returning
          the response back the the client
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analysis/listLatest:
    get:
      summary: Retrieve the last *count* operations per current account
      description: ""
      operationId: retriveLatestUsingGET
      x-api-path-slug: restv1-1analysislistlatest-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: count
        description: How many records to retrieve at a time
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analysis/recognition:
    post:
      summary: Perform labeled recognition on a given picture or picture URL
      description: ""
      operationId: performRecognitionUsingPOST
      x-api-path-slug: restv1-1analysisrecognition-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: algorithmVersion
        description: Algorithm version (V2 is more performant but not backward compatible)
      - in: query
        name: attributeFilters
        description: Filters that will be applied on the recognition operation
      - in: query
        name: collectionId
        description: Uniquely identified collection that can store multiple profiles
      - in: query
        name: filters
        description: '[For advanced users only] Change feature filters for robustness
          of feature extraction'
      - in: query
        name: labels
        description: Labels associated with the given picture or picture URL
      - in: query
        name: options
        description: '[For advanced users only] Options for preprocessing of image'
      - in: formData
        name: picture
        description: The picture itself
      - in: query
        name: pictureURL
        description: The URL of the picture
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: skipEXIF rotation processing
        description: Skip EXIF rotation procesing
      - in: query
        name: storeAnalysisPicture
        description: Boolean value indicating whether you want the picture of the
          analysis to be stored for later retrieval
      - in: query
        name: storeFacePictures
        description: Boolean value indicating whether you want the faces inside the
          picture to be stored for later retrieval
      - in: query
        name: storePicture
        description: Boolean value indicating whether you want the original picture
          to be stored for later retrieval
      - in: query
        name: storeResult
        description: Boolean value indicating whether you want the result of the analysis
          to be stored
      - in: query
        name: waitForPictureUpload
        description: Waits until the picture is successfully uploaded, before returning
          the response back the the client
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analysis/retrieve:
    get:
      summary: Retrieve a complete analysis object including both detection and recognition
        information
      description: ""
      operationId: retrieveAnalysisUsingGET
      x-api-path-slug: restv1-1analysisretrieve-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: analysisId
        description: The ID of the analysis for which the data will be retrieved
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analytics/counting:
    post:
      summary: Count individuals in streams or collections
      description: ""
      operationId: counterUsingPOST
      x-api-path-slug: restv1-1analyticscounting-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionIds
        description: Collection ids
      - in: query
        name: endDateTime
        description: endDateTime
      - in: query
        name: maxBatchIterations
        description: maxBatchIterations
      - in: query
        name: maxIterations
        description: maxIterations
      - in: query
        name: mergingStep
        description: mergingStep
      - in: query
        name: minNeighborsMergedPerIteration
        description: minNeighborsMergedPerIteration
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: shuffling
        description: shuffling
      - in: query
        name: startDateTime
        description: startDateTime
      - in: query
        name: streamIds
        description: Stream Ids
      - in: query
        name: visitDuration
        description: visitDuration
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analytics/presence/timeseries:
    post:
      summary: Show audience (based on number of occurrences of each person) breakdown
        per declared attribute (age, gender).
      description: ""
      operationId: presenceTimeseriesUsingPOST
      x-api-path-slug: restv1-1analyticspresencetimeseries-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: attributes
        description: attributes
      - in: query
        name: endDateTime
        description: endDateTime
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: startDateTime
        description: startDateTime
      - in: query
        name: step
        description: step
      - in: query
        name: streamIds
        description: Stream Ids
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/analytics/presence/total:
    post:
      summary: Show presence (based on number of occurences of each face) breakdown
        per declared attribute (age, gender)
      description: ""
      operationId: presenceTotalUsingPOST
      x-api-path-slug: restv1-1analyticspresencetotal-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: attributes
        description: attributes
      - in: query
        name: endDateTime
        description: endDateTime
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: startDateTime
        description: startDateTime
      - in: query
        name: streamIds
        description: Stream Ids
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/classifier/svm:
    delete:
      summary: Delete existing classifier
      description: ""
      operationId: removeClassiferUsingDELETE
      x-api-path-slug: restv1-1classifiersvm-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: id
        description: The id of the classifier that will be removed
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    get:
      summary: Get classifier full
      description: ""
      operationId: getClassiferFullUsingGET
      x-api-path-slug: restv1-1classifiersvm-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: id
        description: The id of the classifier that you want the status for
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    post:
      summary: Create new SVM classifier with given name
      description: ""
      operationId: addSVMClassifierUsingPOST
      x-api-path-slug: restv1-1classifiersvm-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: cacheSizeParameter
        description: Cache size parameter
      - in: query
        name: classificationAttributeName
        description: Classification attribute name
      - in: query
        name: collectionIds
        description: Collection ids
      - in: query
        name: considerViewPoints
        description: Consider view point
      - in: query
        name: cParameter
        description: c parameter
      - in: query
        name: epsParameter
        description: Eps parameter
      - in: query
        name: gammaParameter
        description: Gamma parameter
      - in: query
        name: kernelTypeParameter
        description: Kernel type parameter
      - in: query
        name: name
        description: The name of the SVM classifier that will be created
      - in: query
        name: nuParameter
        description: Nu parameter
      - in: query
        name: preprocessor
        description: Preprocessor
      - in: query
        name: probabilityParameter
        description: Probability parameter
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: seed
        description: Seed for divididing training and evaluation sets
      - in: query
        name: svmTypeParameter
        description: SVM type parameter
      - in: query
        name: trainingRatio
        description: Training ratio
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/classifier/svm/status:
    get:
      summary: Get classifer status
      description: ""
      operationId: getClassiferStatusUsingGET
      x-api-path-slug: restv1-1classifiersvmstatus-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: id
        description: The id of the classifier that you want the status for
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/:
    get:
      summary: Retrieve all collections
      description: ""
      operationId: getAllCollectionsUsingGET
      x-api-path-slug: restv1-1collection-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    post:
      summary: Create new empty collection with given name
      description: ""
      operationId: addCollectionUsingPOST
      x-api-path-slug: restv1-1collection-post
      parameters:
      - in: formData
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: formData
        name: evictable
        description: Defined whether the collection can be evicted
      - in: formData
        name: name
        description: The name of the collection that will be created
      - in: formData
        name: preload
        description: Defined whether to preload collection
      - in: formData
        name: purposes
        description: The newly declared purposes of the collection
      - in: formData
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/all:
    get:
      summary: Retrieve all collections
      description: ""
      operationId: getAllCollections2UsingGET
      x-api-path-slug: restv1-1collectionall-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/collection:
    delete:
      summary: Delete existing collection with associated profiles and faces.
      description: ""
      operationId: deleteCollection2UsingDELETE
      x-api-path-slug: restv1-1collectioncollection-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The id of the collection that will be removed
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    get:
      summary: Retrieve existing collection content
      description: ""
      operationId: getCollection2UsingGET
      x-api-path-slug: restv1-1collectioncollection-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The id of the collection for which the data will be retrieved
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    post:
      summary: Create new empty collection with given name
      description: ""
      operationId: addCollection2UsingPOST
      x-api-path-slug: restv1-1collectioncollection-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionName
        description: The name of the collection that will be created
      - in: query
        name: evictable
        description: Defined whether the collection can be evicted
      - in: query
        name: preload
        description: Defined whether to preload collection
      - in: query
        name: purposes
        description: The newly declared purposes of the collection
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/export/csv:
    get:
      summary: Retrieve collection content for data analysis.
      description: ""
      operationId: exportCSVUsingGET
      x-api-path-slug: restv1-1collectionexportcsv-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The id of the collection for which the data will be retrieved
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/purpose:
    put:
      summary: Change purpose of existing collection
      description: ""
      operationId: repurposeCollectionUsingPUT
      x-api-path-slug: restv1-1collectionpurpose-put
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The id of the collection for which the data will be retrieved
      - in: query
        name: purposes
        description: The newly declared purposes of the collection
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/{id}:
    delete:
      summary: Delete existing collection with associated profiles and faces.
      description: ""
      operationId: deleteCollectionUsingDELETE
      x-api-path-slug: restv1-1collectionid-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: path
        name: id
        description: The id of the collection that will be removed
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    get:
      summary: Retrieve existing collection content
      description: ""
      operationId: getCollectionUsingGET
      x-api-path-slug: restv1-1collectionid-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: path
        name: id
        description: The id of the collection for which the data will be retrieved
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    patch:
      summary: Update an existing collection with a given id
      description: ""
      operationId: updateCollectionUsingPATCH
      x-api-path-slug: restv1-1collectionid-patch
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: path
        name: id
        description: The id of the collection that will be updated
      - in: query
        name: name
        description: The name of the collection that will be updated
      - in: query
        name: purposes
        description: The newly declared purposes of the collection
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    post:
      summary: Update an existing collection with a given id
      description: ""
      operationId: updateCollection2UsingPOST
      x-api-path-slug: restv1-1collectionid-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: path
        name: id
        description: The id of the collection that will be updated
      - in: query
        name: name
        description: The name of the collection that will be updated
      - in: query
        name: purposes
        description: The newly declared purposes of the collection
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/collection/{id}/profile:
    get:
      summary: Gets all the profiles associated to a collection
      description: ""
      operationId: getAllCollectionProfilesUsingGET
      x-api-path-slug: restv1-1collectionidprofile-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: path
        name: id
        description: The collection that contains the profile
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/profile/classificationAttributes:
    delete:
      summary: Removes classification attributes from a profile
      description: ""
      operationId: removeClassificationAttributesFromProfileUsingDELETE
      x-api-path-slug: restv1-1profileclassificationattributes-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: profileId
        description: The profile associated with the classification attributes
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    get:
      summary: Gets classification attributes from a profile
      description: ""
      operationId: getClassificationAttributesFromProfileUsingGET
      x-api-path-slug: restv1-1profileclassificationattributes-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: profileId
        description: The profile associated with the classification attributes
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    put:
      summary: Maps classification attributes to a profile
      description: ""
      operationId: mapClassificationAttributesToProfileUsingPUT
      x-api-path-slug: restv1-1profileclassificationattributes-put
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: classificationAttributes
        description: Comma separated key:value classification attributes
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: profileId
        description: The profile associated with the classification attributes
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/profile/enrollmentStatus:
    get:
      summary: 'Gets the enrollment status of a profile: information on whether it
        is suitable for authentication.'
      description: ""
      operationId: getProfileEnrollmentStatusUsingGET
      x-api-path-slug: restv1-1profileenrollmentstatus-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: profileId
        description: The profile that contains the faces
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/profile/map:
    delete:
      summary: Removes (unmaps) a list of faces, identified by faceHashes, from a
        profile, identified by profileId
      description: ""
      operationId: removeFacesFromProfileUsingDELETE
      x-api-path-slug: restv1-1profilemap-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: faceHash
        description: The face that will be removed from a profile
      - in: query
        name: faceHashes
        description: Comma separated face hashes, that will be removed from a profile
      - in: query
        name: profileId
        description: The profile that contains the face
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    get:
      summary: Gets all the faceHashes associated to a profile
      description: ""
      operationId: getFacesFromProfileUsingGET
      x-api-path-slug: restv1-1profilemap-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: profileId
        description: The profile that contains the faces
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    post:
      summary: Adds (maps) a list of faces, identified by faceHashes, to a profile,
        identified by profileId
      description: ""
      operationId: mapFacesToProfileUsingPOST
      x-api-path-slug: restv1-1profilemap-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: The collection that contains the profile
      - in: query
        name: faceHash
        description: The face that will be added to a profile
      - in: query
        name: faceHashes
        description: Comma separated face hashes, that will be associated to a profile
      - in: query
        name: profileId
        description: The profile that will store the face
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/profile/profile:
    delete:
      summary: Deletes a profile and unmaps all its faces
      description: ""
      operationId: deleteProfile2UsingDELETE
      x-api-path-slug: restv1-1profileprofile-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: Uniquely identified collection that can store multiple profiles
      - in: query
        name: profileId
        description: The profile id (provide this if you dont have the externalId
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    post:
      summary: Creates a new profile with no faces associated to it (empty profile)
      description: ""
      operationId: addProfileUsingPOST
      x-api-path-slug: restv1-1profileprofile-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: classificationAttributes
        description: Comma separated key:value classification attributes
      - in: query
        name: collectionId
        description: Uniquely identified collection that can store multiple profiles
      - in: query
        name: details
        description: Comma separated key:value details of profile
      - in: query
        name: externalId
        description: External reference to additional information you don???t want
          to share with VisageCloud
      - in: query
        name: labels
        description: Allows you to do finer filtering in face recognition
      - in: query
        name: screenName
        description: Human-readable label for the profile
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/profile/{id}:
    delete:
      summary: Deletes a profile and unmaps all its faces
      description: ""
      operationId: deleteProfileUsingDELETE
      x-api-path-slug: restv1-1profileid-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: Uniquely identified collection that can store multiple profiles
      - in: path
        name: id
        description: The profile id (provide this if you dont have the externalId
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
    get:
      summary: Retrieves a profile
      description: ""
      operationId: getProfileUsingGET
      x-api-path-slug: restv1-1profileid-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: collectionId
        description: Uniquely identified collection that can store multiple profiles
      - in: path
        name: id
        description: The profile id (provide this if you dont have the externalId
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: withFaces
        description: Retrieves the profile with all its associated faces
      responses:
        200:
          description: OK
      tags:
      - ""
    patch:
      summary: Update an existing profile with a given id
      description: ""
      operationId: updateProfileUsingPATCH
      x-api-path-slug: restv1-1profileid-patch
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: classificationAttributes
        description: Comma separated key:value classification attributes
      - in: query
        name: collectionId
        description: Uniquely identified collection that can store multiple profiles
      - in: query
        name: details
        description: Comma separated key:value details of profile
      - in: query
        name: externalId
        description: External reference to additional information you don???t want
          to share with VisageCloud
      - in: path
        name: id
        description: The id of the profile that will be updated
      - in: query
        name: labels
        description: Allows you to do finer filtering in face recognition
      - in: query
        name: screenName
        description: Human-readable label for the profile
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/all:
    get:
      summary: Show status of all streams from account
      description: ""
      operationId: streamsByAccountUsingGET
      x-api-path-slug: restv1-1streamall-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/attendance:
    get:
      summary: Get last N recognized individuals from stream
      description: ""
      operationId: getLastNAttedanceUsingGET
      x-api-path-slug: restv1-1streamattendance-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: count
        description: How many frames to retrieve at a time
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: streamIds
        description: The id of the stream for which the frames will be retrieved
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/cleanup:
    patch:
      summary: Cleanup frames older than specified timeframe
      description: ""
      operationId: cleanupStreamUsingPATCH
      x-api-path-slug: restv1-1streamcleanup-patch
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: interval
        description: Frames older than interval (seconds) will be cleaned up
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      - in: query
        name: streamId
        description: The id of the stream that will be stopped
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/frameImage:
    get:
      summary: Get individual frame image
      description: ""
      operationId: getFrameImageUsingGET
      x-api-path-slug: restv1-1streamframeimage-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: streamId
        description: The id of the stream for which the frames will be retrieved
      - in: query
        name: timestamp
        description: Timestamp of frame to retrieve
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/frames:
    get:
      summary: Get last processed N frames from stream
      description: ""
      operationId: getLastNFramesUsingGET
      x-api-path-slug: restv1-1streamframes-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: attributeFilters
        description: Filters that will be applied on the recognition operation
      - in: query
        name: collectionId
        description: The collection id you want to run recognition against
      - in: query
        name: count
        description: How many frames to retrieve at a time
      - in: query
        name: labels
        description: Labels associated with the given picture or picture URL
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      - in: query
        name: streamId
        description: The id of the stream for which the frames will be retrieved
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/start:
    patch:
      summary: Start existing stream
      description: ""
      operationId: startStreamUsingPATCH
      x-api-path-slug: restv1-1streamstart-patch
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: id
        description: The id of the stream that will be started
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      - in: query
        name: streamId
        description: The id of the stream that will be started
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/stop:
    patch:
      summary: Stop existing stream
      description: ""
      operationId: stopStreamUsingPATCH
      x-api-path-slug: restv1-1streamstop-patch
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: id
        description: The id of the stream that will be stopped
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      - in: query
        name: streamId
        description: The id of the stream that will be stopped
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/stream:
    post:
      summary: Create new stream with given name
      description: ""
      operationId: addStreamUsingPOST
      x-api-path-slug: restv1-1streamstream-post
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: associatedCollections
        description: List of collection ids which will be used to measure attendance
      - in: query
        name: attributes
        description: Attributes of the stream
      - in: query
        name: isActive
        description: Boolean value indicating whether the stream is currently active
          or not
      - in: query
        name: method
        description: Streaming method
      - in: query
        name: name
        description: The name of the stream that will be created
      - in: query
        name: password
        description: Password
      - in: query
        name: retentionTime
        description: Number of seconds for frames to be kept
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      - in: query
        name: skipFramesWithNoFaces
        description: Boolean value indicating whether you want the original picture
          to be stored for later retrieval
      - in: query
        name: storeAttendanceFaces
        description: Boolean value indicating whether you want to store permanently
          store faces clippings of the recognized faces
      - in: query
        name: storeAttendanceFrames
        description: Boolean value indicating whether you want to store permanently
          store frames with a recognized face in them
      - in: query
        name: storeOriginalFrames
        description: Boolean value indicating whether you want the original picture
          to be stored for later retrieval
      - in: query
        name: url
        description: The url of the stream
      - in: query
        name: username
        description: Username
      responses:
        200:
          description: OK
      tags:
      - ""
    delete:
      summary: Delete existing stream
      description: ""
      operationId: removeStreamUsingDELETE
      x-api-path-slug: restv1-1streamstream-delete
      parameters:
      - in: query
        name: id
        description: The id of the stream that will be removed
      - in: query
        name: secretKey
        description: The secretKey or readOnlyKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/{id}:
    delete:
      summary: Delete existing stream
      description: ""
      operationId: removeStreamUsingDELETE
      x-api-path-slug: restv1-1streamid-delete
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: path
        name: id
        description: The id of the stream that will be removed
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      responses:
        200:
          description: OK
      tags:
      - ""
  /rest/v1.1/stream/{streamId}:
    get:
      summary: Get an existing stream with a given ID
      description: ""
      operationId: getStreamUsingGET
      x-api-path-slug: restv1-1streamstreamid-get
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      - in: path
        name: streamId
        description: The id of the stream for which the data will be retrieved
      responses:
        200:
          description: OK
      tags:
      - ""
    patch:
      summary: Update an existing stream with a given ID
      description: ""
      operationId: updateStreamUsingPATCH
      x-api-path-slug: restv1-1streamstreamid-patch
      parameters:
      - in: query
        name: accessKey
        description: The accessKey provided by VisageCloud
      - in: query
        name: associatedCollections
        description: List of collection ids which will be used to measure attendance
      - in: query
        name: attributes
        description: Attributes of the stream
      - in: query
        name: retentionTime
        description: Number of seconds for frames to be kept
      - in: query
        name: secretKey
        description: The secretKey provided by VisageCloud
      - in: query
        name: storeAttendanceFaces
        description: Boolean value indicating whether you want to store permanently
          store faces clippings of the recognized faces
      - in: query
        name: storeAttendanceFrames
        description: Boolean value indicating whether you want to store permanently
          store frames with a recognized face in them
      - in: query
        name: storeOriginalFrames
        description: Boolean value indicating whether you want the original picture
          to be stored for later retrieval
      - in: path
        name: streamId
        description: The id of the stream that will be updated
      responses:
        200:
          description: OK
      tags:
      - ""
x-streamrank:
  polling_total_time_average: 0
  polling_size_download_average: 0
  streaming_total_time_average: 0
  streaming_size_download_average: 0
  change_yes: 0
  change_no: 0
  time_percentage: 0
  size_percentage: 0
  change_percentage: 0
  last_run: ""
  days_run: 0
  minute_run: 0
---