{"_id":"@apiverve/imagecaption","_rev":"3-c8cdcbd84e6419283d715774d07efa35","name":"@apiverve/imagecaption","dist-tags":{"latest":"1.2.0"},"versions":{"1.1.13":{"name":"@apiverve/imagecaption","version":"1.1.13","keywords":[],"author":{"url":"https://apiverve.com","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/imagecaption@1.1.13","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/imagecaption?utm_source=npm&utm_medium=homepage","bugs":{"url":"https://github.com/apiverve/imagecaption-api/issues"},"dist":{"shasum":"6372ee0d777f2a7bdc82d0e77a79475f75941dc1","tarball":"https://registry.npmjs.org/@apiverve/imagecaption/-/imagecaption-1.1.13.tgz","fileCount":5,"integrity":"sha512-OQushR+5P1FXuXMcyAet1OBZ4qBj59xrEhU46GooHWwK3K5HlBTtSF5oqN3Jknq0lt6r9SR5Kov7oxC/f/8xSQ==","signatures":[{"sig":"MEUCIQCnRdivp/eeeMhQ4wmMlfacTwDNy/EgNvyUc4H2wY01kQIgNqM+uQRNV3DvgTnF34+M9qf/gHfGz/7Kra9PP7x+kwY=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":21172},"main":"index.js","types":"index.d.ts","engines":{"node":">=14.0.0"},"gitHead":"603be281ba20b71024115a78fa6ae64907e245cc","scripts":{"test":"mocha","example":"node examples/basic.js"},"_npmUser":{"name":"charifield","email":"charifield@gmail.com"},"repository":{"url":"git+https://github.com/apiverve/imagecaption-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Image Caption is an AI-powered tool that generates descriptive captions for images. Simply upload an image and receive a natural language description of its contents.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.0","dependencies":{"axios":"1.13.2","promise":"^8.3.0","node-fetch":"^3.3.2"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.2","mocha":"^11.0.1","dotenv":"^16.4.7"},"_npmOperationalInternal":{"tmp":"tmp/imagecaption_1.1.13_1771045742504_0.8552605554095922","host":"s3://npm-registry-packages-npm-production"}},"1.1.14":{"name":"@apiverve/imagecaption","version":"1.1.14","keywords":[],"author":{"url":"https://apiverve.com","name":"APIVerve","email":"hello@apiverve.com"},"license":"MIT","_id":"@apiverve/imagecaption@1.1.14","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"homepage":"https://apiverve.com/marketplace/imagecaption?utm_source=npm&utm_medium=homepage","bugs":{"url":"https://github.com/apiverve/imagecaption-api/issues"},"dist":{"shasum":"7961a3750d298538c5c1bddd738969e6f8981882","tarball":"https://registry.npmjs.org/@apiverve/imagecaption/-/imagecaption-1.1.14.tgz","fileCount":5,"integrity":"sha512-m46bwdIFZF1eXots0ZP/BsFDwY79sWf7IUjTJjg8QQQDVkGjqOUr9YNCdt4sGNNiqMW0JcG/3wvwurz585jUww==","signatures":[{"sig":"MEYCIQCqMBb/1FPb7v2Wq+NKckGJylEbn65RLn4gdNXoixVxGgIhAIYbTWISCemiDW66lpZvbT4UvgnHUDworm6STwavmZ+G","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":20881},"main":"index.js","types":"index.d.ts","engines":{"node":">=14.0.0"},"gitHead":"2f35257ac4df6e979213a38ff3974fd82a1cf5b1","scripts":{"test":"mocha","example":"node examples/basic.js"},"_npmUser":{"name":"charifield","email":"charifield@gmail.com"},"repository":{"url":"git+https://github.com/apiverve/imagecaption-api.git","type":"git","directory":"npm"},"_npmVersion":"10.9.3","description":"Image Caption is an AI-powered tool that generates descriptive captions for images. Simply upload an image and receive a natural language description of its contents.","directories":{},"sideEffects":false,"_nodeVersion":"22.22.0","dependencies":{"axios":"1.13.2","promise":"^8.3.0","node-fetch":"^3.3.2"},"_hasShrinkwrap":false,"devDependencies":{"chai":"^5.1.2","mocha":"^11.0.1","dotenv":"^16.4.7"},"_npmOperationalInternal":{"tmp":"tmp/imagecaption_1.1.14_1771237734083_0.9623534967250165","host":"s3://npm-registry-packages-npm-production"}},"1.2.0":{"name":"@apiverve/imagecaption","version":"1.2.0","description":"Image Caption is an AI-powered tool that generates descriptive captions for images. Simply upload an image and receive a natural language description of its contents.","main":"index.js","types":"index.d.ts","sideEffects":false,"engines":{"node":">=18.0.0"},"scripts":{"test":"mocha","example":"node examples/basic.js"},"repository":{"type":"git","url":"git+https://github.com/apiverve/imagecaption-api.git","directory":"npm"},"keywords":["image caption","image description","image to text","ai image caption","describe image"],"author":{"name":"APIVerve","email":"hello@apiverve.com","url":"https://apiverve.com"},"license":"MIT","bugs":{"url":"https://github.com/apiverve/imagecaption-api/issues"},"homepage":"https://apiverve.com/marketplace/imagecaption?utm_source=npm&utm_medium=homepage","devDependencies":{"mocha":"^11.0.1","chai":"^5.1.2","dotenv":"^16.4.7"},"dependencies":{"axios":"1.13.2","form-data":"^4.0.1"},"gitHead":"2878cdb345f00af84126a08bcc1be2b68ae96fec","_id":"@apiverve/imagecaption@1.2.0","_nodeVersion":"24.15.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-yT2IMGDTxd0MVdqQhae3SfDSRWA2cjcs41dzmvg+ybyD9V8B0IPHbccKUUKpPKYggFsLtu62Gr2wlGzYSmtwLA==","shasum":"80a142846fdd8223610e52d29eb024c182face31","tarball":"https://registry.npmjs.org/@apiverve/imagecaption/-/imagecaption-1.2.0.tgz","fileCount":5,"unpackedSize":21324,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDGEI4E5ee4ca1qVKx/VJrfUU5evkgfmf25XnUo58+6eAIhAIMQs3rWORZO3BSJDTJxDDoLLk/K3/UiKxkPQzfaMKeK"}]},"_npmUser":{"name":"apivervehq","email":"hello@apiverve.com"},"directories":{},"maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/imagecaption_1.2.0_1784150829179_0.8757170498710063"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-14T05:09:02.418Z","modified":"2026-07-15T21:27:09.484Z","1.1.13":"2026-02-14T05:09:02.657Z","1.1.14":"2026-02-16T10:28:54.214Z","1.2.0":"2026-07-15T21:27:09.327Z"},"bugs":{"url":"https://github.com/apiverve/imagecaption-api/issues"},"author":{"name":"APIVerve","email":"hello@apiverve.com","url":"https://apiverve.com"},"license":"MIT","homepage":"https://apiverve.com/marketplace/imagecaption?utm_source=npm&utm_medium=homepage","keywords":["image caption","image description","image to text","ai image caption","describe image"],"repository":{"type":"git","url":"git+https://github.com/apiverve/imagecaption-api.git","directory":"npm"},"description":"Image Caption is an AI-powered tool that generates descriptive captions for images. Simply upload an image and receive a natural language description of its contents.","maintainers":[{"name":"charifield","email":"charifield@gmail.com"},{"name":"apivervehq","email":"hello@apiverve.com"}],"readme":"# Image Caption API\r\n\r\nImage Caption is an AI-powered tool that generates descriptive captions for images. Simply upload an image and receive a natural language description of its contents.\r\n\r\n![Build Status](https://img.shields.io/badge/build-passing-green)\r\n![Code Climate](https://img.shields.io/badge/maintainability-B-purple)\r\n![Prod Ready](https://img.shields.io/badge/production-ready-blue)\r\n[![npm version](https://img.shields.io/npm/v/@apiverve/imagecaption.svg)](https://www.npmjs.com/package/@apiverve/imagecaption)\r\n\r\nThis is a Javascript Wrapper for the [Image Caption API](https://apiverve.com/marketplace/imagecaption?utm_source=npm&utm_medium=readme)\r\n\r\n---\r\n\r\n## Installation\r\n\r\nUsing npm:\r\n```shell\r\nnpm install @apiverve/imagecaption\r\n```\r\n\r\nUsing yarn:\r\n```shell\r\nyarn add @apiverve/imagecaption\r\n```\r\n\r\n---\r\n\r\n## Configuration\r\n\r\nBefore using the Image Caption API client, you have to setup your account and obtain your API Key.\r\nYou can get it by signing up at [https://apiverve.com](https://apiverve.com?utm_source=npm&utm_medium=readme)\r\n\r\n---\r\n\r\n## Quick Start\r\n\r\n[Get started with the Quick Start Guide](https://docs.apiverve.com/quickstart?utm_source=npm&utm_medium=readme)\r\n\r\nThe Image Caption API documentation is found here: [https://docs.apiverve.com/ref/imagecaption](https://docs.apiverve.com/ref/imagecaption?utm_source=npm&utm_medium=readme).\r\nYou can find parameters, example responses, and status codes documented here.\r\n\r\n### Setup\r\n\r\n```javascript\r\nconst imagecaptionAPI = require('@apiverve/imagecaption');\r\nconst api = new imagecaptionAPI({\r\n    api_key: '[YOUR_API_KEY]'\r\n});\r\n```\r\n\r\n---\r\n\r\n## Usage\r\n\r\n### File Upload\r\n\r\nThis API requires a file upload. Use `executeWithFile()` to upload files:\r\n\r\n```javascript\r\n// Upload a file (path, Buffer, or ReadStream)\r\napi.executeWithFile('/path/to/file.image', options, callback);\r\n```\r\n\r\n**Accepted file types:** .jpg, .jpeg, .png, .gif\r\n**Maximum file size:** 5 MB\r\n\r\n---\r\n\r\n### Perform Request\r\n\r\nUsing the API is simple. All you have to do is make a request. The API will return a response with the data you requested.\r\n\r\n```javascript\r\n// This API requires a file upload\n// You can pass a file path, Buffer, or ReadStream\nvar filePath = '/path/to/image.jpg';\r\n\r\napi.executeWithFile(filePath, function (error, data) {\r\n    if (error) {\r\n        return console.error(error);\r\n    } else {\r\n        console.log(data);\r\n    }\r\n});\r\n```\r\n\r\n---\r\n\r\n### Using Promises\r\n\r\nYou can also use promises to make requests. The API returns a promise that you can use to handle the response.\r\n\r\n```javascript\r\n// This API requires a file upload\n// You can pass a file path, Buffer, or ReadStream\nvar filePath = '/path/to/image.jpg';\r\n\r\napi.executeWithFile(filePath)\r\n    .then(data => {\r\n        console.log(data);\r\n    })\r\n    .catch(error => {\r\n        console.error(error);\r\n    });\r\n```\r\n\r\n---\r\n\r\n### Using Async/Await\r\n\r\nYou can also use async/await to make requests. The API returns a promise that you can use to handle the response.\r\n\r\n```javascript\r\nasync function makeRequest() {\r\n    // This API requires a file upload\n// You can pass a file path, Buffer, or ReadStream\nvar filePath = '/path/to/image.jpg';\r\n\r\n    try {\r\n        const data = await api.executeWithFile(filePath);\r\n        console.log(data);\r\n    } catch (error) {\r\n        console.error(error);\r\n    }\r\n}\r\n```\r\n\r\n---\r\n\r\n## Example Response\r\n\r\n```json\r\n{\n  \"status\": \"ok\",\n  \"error\": null,\n  \"data\": {\n    \"caption\": \"A golden retriever running through a grassy field on a sunny day\"\n  }\n}\r\n```\r\n\r\n---\r\n\r\n## Customer Support\r\n\r\nNeed any assistance? [Get in touch with Customer Support](https://apiverve.com/contact?utm_source=npm&utm_medium=readme).\r\n\r\n---\r\n\r\n## Updates\r\n\r\nStay up to date by following [@apiverveHQ](https://twitter.com/apiverveHQ) on Twitter.\r\n\r\n---\r\n\r\n## Legal\r\n\r\nAll usage of the APIVerve website, API, and services is subject to the [APIVerve Terms of Service](https://apiverve.com/terms?utm_source=npm&utm_medium=readme), [Privacy Policy](https://apiverve.com/privacy?utm_source=npm&utm_medium=readme), and [Refund Policy](https://apiverve.com/refund?utm_source=npm&utm_medium=readme).\r\n\r\n---\r\n\r\n## License\r\nLicensed under the The MIT License (MIT)\r\n\r\nCopyright (©) 2026 APIVerve, and EvlarSoft LLC\r\n\r\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\r\n\r\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\r\n","readmeFilename":"README.md"}