Virbe Documentation
DevelopersAPI Reference

Authentication

How to authenticate with the Virbe API using API keys.

All API requests must include the x-virbe-api-key header with a valid API key.

Creating an API Key

  1. Navigate to Settings → API Keys in your Virbe dashboard.
  2. Click Create new secret key.
  3. Give your key a name, select the required scopes, and save it. Copy the key immediately – it will not be shown again.

Scopes

Each API key can be assigned one or more scopes that control what it can access:

  • EndUser – read end user data and variables
  • Conversation – read conversation history and variables
  • ConversationActions – send messages to active conversations
  • Profile – read assistant profile information

Example Request

curl -X GET \
  "https://my-assistant.virbe.app/api/v1/end-users" \
  -H "x-virbe-api-key: YOUR_API_KEY"

Never expose your API key in client-side code or public repositories. Keep it stored securely on your server.

API Reference

Programmatic access to Virbe assistant data including end users, conversations, and messages.

Conversations

Manage conversation history, variables, and human handover via the Virbe API.

On this page

Creating an API KeyScopesExample Request