VS Agent is a web application that can be used as a framework for building conversational Verifiable Services (VS) that integrate seamlessly with the Hologram Messaging App and other compatible DIDCommm agents. It enables developers to create, deploy, and manage agents that provide trustworthy, verifiable information and actions in chat conversations.

• Simple REST API to send messages and receive events from connected users. No need to have knowledge on DIDComm: all the complexity is managed internally!
• Issue and verify AnonCreds credentials, with revocation support
• Built-in Verifiable Trust implementation
• Hands-on client for easy integrations in existing backends using NestJS

The easiest way to get started with VS Agent is by using Docker. Pull the image from Docker Hub:

docker pull io2060/vs-agent

Or build it directly from this repo:

docker build -t vs-agent:dev -f ./apps/vs-agent/Dockerfile .

Then, you can just run it. Don't forget to set the environment variables as required! See VS Agent Configuration for a detailed description:

docker run --env-file ./env-vars io2060/vs-agent

Once your VS Agent is up and running, you can manage it from your backend basically in three different ways

NestJS client can be imported as a module in your backend, and it will implement all endpoints required to handle event coming from VS Agent. It also provides some extra models to manage credential revocation, use statistics and handling user profile (including useful information such as preferred language). See [NestJS client documentation]((./packages/nestjs-client/README.md) for more details.

Base client provides a basic model for every VS API message and event, and it is handy when you want to create a simple backend based on NodeJS, especially if you use Express. See JS client documentation for more details.

This can be used regardless the software stack you use in your backend. See VS Agent API reference for a detailed guide about all endpoints.

See examples for fully working demos that can be run locally using Docker.

Contributions are welcome! Please:

1. Fork the repository
2. Create a feature branch (git checkout -b feat/your-feature)
3. Commit your changes (git commit -m 'Add feature')
4. Push to the branch (git push origin feature/your-feature)
5. Open a Pull Request

Please follow the code style and write tests for new features.

This project is pulished under Apache license. See LICENSE for more information.

For questions or support, you are welcome to open an issue.