Skip to content

Generate alt description tag for an image on the fly using OpenAI

License

Notifications You must be signed in to change notification settings

Eyevinn/img-alt-gen

Repository files navigation

Image Description Generator

Generate alt description tag for an image on the fly using OpenAI

PRs welcome made with hearth by Eyevinn Slack

Generate alt description tag for an image to improve accessability. Uses OpenAI LLM for describing the image.

Requirements

  • Open AI account and API key

Installation / Usage

% npm install
% OPENAI_API_KEY=<your-api-key> npm start

API documentation available at http://localhost:8000/docs.

Output in HTML

% curl "http://localhost:8000/image/alt?url=https%3A%2F%2Fblog.osaas.io%2Fwp-content%2Fuploads%2F2025%2F02%2Fimage-1536x851.png"
<img src="https://blog.osaas.io/wp-content/uploads/2025/02/image-1536x851.png" alt="The image presents an HLS monitoring dashboard displaying active stream statuses, uptime, error counts, and current issues." />

Output in plain text

% curl "http://localhost:8000/image/alt?url=https%3A%2F%2Fblog.osaas.io%2Fwp-content%2Fuploads%2F2025%2F02%2Fimage-1536x851.png&format=text"
The image shows a dashboard displaying stream monitor statuses, uptime, error counts, and error distribution data for two active streams.

Contributing

See CONTRIBUTING

License

This project is licensed under the MIT License, see LICENSE.

Support

Join our community on Slack where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:

  • Further development of this component
  • Customization and integration of this component into your platform
  • Support and maintenance agreement

Contact sales@eyevinn.se if you are interested.

About Eyevinn Technology

Eyevinn Technology is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in blogs and by open sourcing the code we have written.

Want to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!

About

Generate alt description tag for an image on the fly using OpenAI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published