Welcome to EveryPixel API 👋

JavaScript client support for EveryPixel API, works in both Node.js and Browser.

Image Keywording
Stock Photography Scoring
UGC Photography Scoring
Age recognition
https://labs.everypixel.com/api

🏠 Homepage

Install

npm i everypixel

Usage

const EveryPixel = require('everypixel');

const api = new EveryPixel({
	"username": "<your-client-id>",
	"password": "<your-client-secret>"
});

// Get 10 suggested keywords of online image
let ret = await api.keywords({"url": "http://image.everypixel.com/2014.12/67439828186edc79b9be81a4dedea8b03c09a12825b_b.jpg", "num_keywords": 10});
console.log(ret.data);
// Get 10 suggested keywords of local image file
let ret = await api.keywords({"data": fs.createReadStream("t/cat.jpg"), "num_keywords": 10});
console.log(ret.data);

keywords

await api.keywords({"url": "http://image.everypixel.com/2014.12/67439828186edc79b9be81a4dedea8b03c09a12825b_b.jpg", "num_keywords": 10});

await api.keywords({"data": fs.createReadStream(appRoot + "/t/cat.jpg"), "num_keywords": 10});

quality

await api.quality({"url": "http://image.everypixel.com/2014.12/67439828186edc79b9be81a4dedea8b03c09a12825b_b.jpg"});

await api.quality({"data": fs.createReadStream(appRoot + "/t/cat.jpg")});

quality_ugc

await api.quality_ugc({"url": "http://image.everypixel.com/2014.12/67439828186edc79b9be81a4dedea8b03c09a12825b_b.jpg"});

await api.quality_ugc({"data": fs.createReadStream(appRoot + "/t/cat.jpg")});

faces

await api.faces({"url": "https://labs.everypixel.com/api/static/i/estest_sample3.jpg"});

await api.faces({"data": fs.createReadStream(appRoot + "/t/face.jpg")});

Run tests

Because EveryPixel doesn't provide free test account, you need to signup at https://labs.everypixel.com/api and get your client tokens with 100 daily free quota of api calls.

Please modify t/test.js and update your token info BEFORE running test.

npm run test

Author

👤 BlueT - Matthew Lien - 練喆明 <BlueT@BlueT.org>

Twitter: @BlueT
Github: @BlueT

🤝 Contributing

Contributions, issues and feature requests are welcome!

Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator

bluet/everypixel-js