API Reference

Complete REST API documentation for the VynFi platform

Authentication

All API requests require a Bearer token in the Authorization header. API keys use the prefix vf_live_ for production and vf_test_ for sandbox environments.

curl -X POST https://api.vynfi.com/v1/generate/quick \
  -H "Authorization: Bearer vf_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"sector": "banking", "tables": [{"name": "journal_entries", "rows": 100}]}'

Generation

Create synthetic financial datasets synchronously or as async jobs.

Jobs

Monitor and manage asynchronous generation jobs.

Catalog

Browse available data sectors and their table schemas.

Usage

Track credit consumption and billing history.

Billing

Manage subscriptions and purchase additional credits.

Error Reference

All error responses follow the RFC 7807 Problem Details format with consistent structure across all endpoints.

{
  "type": "https://api.vynfi.com/errors/insufficient-credits",
  "title": "Insufficient Credits",
  "status": 402,
  "detail": "This request requires 15,000 credits but only 3,200 remain.",
  "instance": "/v1/generate/quick",
  "credits_required": 15000,
  "credits_available": 3200
}

Rate Limits

API requests are rate-limited per tier. When you exceed your limit, the API returns a 429 Too Many Requests response with a Retry-After header indicating how long to wait before retrying.

Related Articles