Docs · API v1

Build on Veloxiz

Connect sources, score business gaps, and pull opportunity briefs - via REST.

Quickstart API reference

Quickstart

Get an API key

Request access - we’ll issue a workspace key.

Connect sources

CRM, analytics, or upload a market sheet.

Pull gaps

GET /v1/gaps returns ranked opportunities.

Act & feedback

Approve or dismiss - scoring gets sharper.

Authentication

Pass your workspace key in the Authorization header. All requests use https://api.veloxiz.ai.

curl https://api.veloxiz.ai/v1/gaps \
  -H "Authorization: Bearer vx_live_..." \
  -H "Content-Type: application/json"

Example

Ask for a gap brief

Natural language in. Ranked opportunities out - with estimated impact.

Request API access

POST /v1/briefs/ask

{
  "query": "Where are we losing
            mid-market SaaS deals?",
  "limit": 5
}

→ gaps[] with impact, evidence,
  confidence, next_move

API reference

POST/v1/sources

Connect a data source (CRM, warehouse, sheet)

GET/v1/gaps

List ranked business gaps for your workspace

GET/v1/gaps/{id}

Full brief - evidence, impact, next move

POST/v1/briefs/ask

Ask a natural-language market question

POST/v1/gaps/{id}/feedback

Approve or dismiss a gap (trains scoring)

GET/v1/briefs/latest

Fetch the latest weekly opportunity brief

Need a workspace key?

We’ll provision access and walk your first gap brief with you.