Developers and Hologram | Learn how to get started with Hologram, and where to find documentation and access community channels.

Getting Started

Learn how to get started with Hologram as a service developer, and where to find documentation and access community channels.

What is a Verifiable Service Agent?

To build services compatible with Hologram, all you need is VS Agent, a web application that can be used as a framework for building conversational Verifiable Services (VS). It enables developers to create, deploy, and manage agents that provide trustworthy, verifiable information and actions in chat conversations.

Get VS Agent

Pull the image from DockerHub and run it in any environment.

Pull the Container

docker pull io2060/vs-agent:dev

Getting Started

You can run it locally or by using Docker, pulling the image from DockerHub. If you want to run it locally, refer to VS Agent repository for full details.

Run your own Hologram Verifiable Service

Running VS Agent is easy: it only needs a few environment variables for its basic configuration. These are the most important ones:

AGENT_PUBLIC_DID

In order to conform with Verifiable Trust concepts, a service needs to have a public decentralized identifier (DID). Hologram supports did:webvh method, a web-based identifier. For this you’ll need to have a public endpoint for your agent and prefix it with did:webvh.

Example:

did:webvh:mypublichost.com

AGENT_LABEL

String to be shown in invitations

AGENT_INVITATION_IMAGE_URL

URL of a logo to be shown in invitations alongside the label

Run the Container

docker run -p 80:3001 -p 3000:3000 \
  -e AGENT_PUBLIC_DID=did:webvh:myhost.com \
  -e AGENT_LABEL=&#34;My First Hologram VS&#34; \
  -e AGENT_INVITATION_IMAGE_URL=https://hologram.zone/images/ico-hologram.png \
  --name io2060/vs-agent:dev

Important Note

Note that it uses two ports: a public one (3001) and a private one (3000), used for its Admin API. It is important that the public endpoint is reachable at the same host you’ve set up in agent’s public DID.

Create QR codes for invitations

Hologram users connect with your VS using invitation codes. For that purpose you can call the endpoint /invitation, which generates an invitation URL, or /qr, which renders this URL as a QR code so the user can simply scan it using their Hologram app.

Invitation URL

GET

/invitation

QR Code

GET

/qr

Sending chat messages

Admin API

You can send messages to users using VS Agent Admin API. Check out VS Agent API documentation and the Swagger UI of your deployed Agent at /api to know more.

API Documentation

Complete reference for all VS Agent API endpoints

Swagger UI

Interactive API

Access Swagger UI at:/api