Skip to content

A moderation API made with care & love by Abdelkhaliq, built for real-world impact. It leverages AI-driven analysis and detection, designed for scalability and open collaboration.

Notifications You must be signed in to change notification settings

abde1khaliq/Vireon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vireon

A moderation API made with care & love by Abdelkhaliq, built for real-world impact. It leverages AI-driven analysis and detection, designed for scalability and open collaboration.

Features

  • 🔍 Moderation: powered by Gemini for deep content analysis
  • 🧱 Modular design: plug-and-play components for flexible integration
  • 📦 Reproducible setup: streamlined onboarding and isolated environments
  • 🧠 Educational tooling: built for targeted use, not mass deployment

API Reference

Text Moderation Endpoint

  POST /v1/analyze/content
Parameter Type Description
api_key string Required. Pass as Authorization: Bearer YOUR_API_KEY in request header
user_input string Required. The text to be moderated
image_url string Required. The image to be moderated
  • ⚠️ You must provide either user_input or image_url — not both. One is required, both are optional, and mixing them will throw an error.

  • 📢 Vireon is shipped with a built-in interface — complete with descriptive documentation, feature previews, and live testing. No guesswork, no setup headaches. Just plug in your key and start moderating.

FAQ

Q: Do I need an API key to use VireonAPI?

Yes. All requests must include your key in the header as: Authorization: Bearer YOUR_API_KEY

Q: Can I send both text and image in one request?

Nope. You must send either user_input (text) or image_url — not both. Each is optional, but one is required to trigger moderation.

Q: Is this meant for production use?

Not yet. VireonAPI is built for targeted educational and experimental use, not mass deployment. It’s modular, transparent, and open to contributions — but not hardened for scale (yet).

Q: Can I contribute or customize the pipeline?

Absolutely. The architecture is plug-and-play. Fork it, tweak it, submit a pull request — just keep it modular and testable.

Contributing

Contributions are always welcome

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Authors

Support

For support, email ahmedthek3@gmail.com. Or join or Discord server Vireon HQ

Feedback

If you have any feedback, please reach out to us at ahmedthek3@gmail.com

Discord; abde1khaliq._

VireonHQ Discord

License

MIT

Logo

About

A moderation API made with care & love by Abdelkhaliq, built for real-world impact. It leverages AI-driven analysis and detection, designed for scalability and open collaboration.

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published