Back to Documentation

Getting Started

Welcome to the Vylot API

The Vylot API allows you to build custom billing workflows, sync your existing inventory, and automate your invoicing completely. Our API is organized around REST, uses standard HTTP response codes, and expects JSON payloads.

Base URL

https://api.vylot.workers.dev/v1

Authentication

Bearer tokens (API Keys)

Rate Limits

Enforced per-business plan

Quick Start Guide

  1. Create a Customer: Use POST /v1/customers to save your customer's details.
  2. Create a Product (Optional): Save a product using POST /v1/products to track inventory.
  3. Generate the Invoice: Call POST /v1/invoices passing the customer_id and items.