https://github.com/jhen0409/node-kairos-api
The Node.js client for the Kairos face recognition API.
https://github.com/jhen0409/node-kairos-api
Last synced: 6 months ago
JSON representation
The Node.js client for the Kairos face recognition API.
- Host: GitHub
- URL: https://github.com/jhen0409/node-kairos-api
- Owner: jhen0409
- License: mit
- Created: 2015-07-28T07:32:39.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2017-02-13T05:59:55.000Z (over 8 years ago)
- Last Synced: 2025-03-12T21:49:29.570Z (7 months ago)
- Language: LiveScript
- Homepage: https://www.kairos.com/docs/face-recognition
- Size: 11.7 KB
- Stars: 5
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kairos face recognition API for Node.js
[](https://www.npmjs.com/package/kairos-api)
## Installation
```
npm install kairos-api
```
## Usage
```js
var Kairos = require('kairos-api');
var client = new Kairos('app_id', 'app_key');
var params = {
image: 'http://media.kairos.com/kairos-elizabeth.jpg',
subject_id: 'subtest1',
gallery_name: 'gallerytest1',
selector: 'SETPOSE'
};
client.enroll(params) // return Promise
// result: {
// status: ,
// body:
// }
.then(function(result) { ... })
// err -> array: jsonschema validate errors
// or throw Error
.catch(function(err) { ... });
```
For more `params` pattern, see [offical doc](https://www.kairos.com/docs/face-recognition).
### Functions
- client.enroll(params)
- client.recognize(params)
- client.detect(params)
- client.galleryListAll()
- client.galleryView(params)
- client.galleryRemove(params)
- client.galleryRemoveSubject(params)
## LICENSE
[MIT](LICENSE)
Test on [RapidAPI](https://rapidapi.com/package/KairosAPI/functions?utm_source=KairosGitHub&utm_medium=button)