Vulgate API Documentation

Welcome to the Vulgate API documentation. Vulgate is a document intelligence platform that lets you ingest, search, and interact with your document libraries through a powerful API.

Upload and process documents of any format — PDFs, images, audio, and more — then query them with semantic or keyword search, or have AI-powered conversations grounded in your content with full source citations.

The API is designed to be OpenAI-compatible, so you can integrate it with any existing SDK that supports the Chat Completions interface.

Authentication

All API endpoints require authentication via a Bearer token in the Authorization header:

Authorization: Bearer <your-api-key>

Setting up your API key

Configure your API key as an environment variable. This approach streamlines your API usage by eliminating the need to include your API key in each request. Moreover, it enhances security by minimizing the risk of inadvertently including your API key in your codebase.

In your terminal of choice:

export VULGATE_API_KEY=<your-api-key-here>

Or, in your project’s .env file:

VULGATE_API_KEY=<your-api-key-here>

Replace <your-api-key-here> with your actual API key, which you can generate in your team dashboard by navigating to Settings > API. See API Console for full details on key management.

Sections

  • API Console - Manage your API keys and monitor usage.
  • Ingest API - Learn how to upload and ingest documents.
  • Search API - Semantic and keyword search across your document libraries.
  • Chat API - AI-powered conversations grounded in your documents.
API Documentation | Vulgate AI