API Documentation

Complete REST API reference. All endpoints require authentication via JWT Bearer token or API key header.

Base URL: https://api.vectoreo.ai

Quick start

# 1. Register and get your API key from the dashboard

# 2. Create a site
curl -X POST https://api.vectoreo.ai/api/v1/sites \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "My Site", "websiteUrl": "https://example.com"}'

# 3. Trigger a crawl job
curl -X POST https://api.vectoreo.ai/api/v1/jobs \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"clientId": "SITE_ID"}'

# 4. Search your content
curl -X POST https://api.vectoreo.ai/api/v1/search/my-site \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"query": "how does your product work?"}'

Authentication

All API requests require one of two authentication methods:

JWT

Authorization: Bearer <token> — Obtained via login endpoint. Access tokens expire in 15 minutes.

API Key

X-API-Key: veo_... — Created from the dashboard. Best for server-to-server communication.

Authentication

POST/api/v1/auth/registerCreate a new account

POST/api/v1/auth/loginSign in and receive JWT tokens

POST/api/v1/auth/refreshRefresh access token

GET/api/v1/auth/meGet current user profile

Sites

POST/api/v1/sitesRegister a new website

GET/api/v1/sitesList all registered sites

GET/api/v1/sites/{id}Get site details

PATCH/api/v1/sites/{id}Update site configuration

DELETE/api/v1/sites/{id}Delete a site and its data

Jobs

POST/api/v1/jobsTrigger a crawl job

GET/api/v1/jobs/{id}Get job status

POST/api/v1/jobs/{id}/cancelCancel a running job

Search

POST/api/v1/search/{slug}Semantic search across site content

POST/api/v1/search/{slug}/filterFilter chunks by metadata

Exports & Discovery

GET/{slug}/dump.ndjsonStream NDJSON content dump

GET/{slug}/dump.jsonFull JSON content dump

GET/{slug}/.well-known/vectors.jsonADP discovery manifest

GET/{slug}/foundation/robots.txtAI-aware robots.txt

GET/{slug}/foundation/llms.txtLLM-friendly content summary

Billing

GET/api/v1/billing/plansList available plans

GET/api/v1/billing/usageGet current usage and limits

POST/api/v1/billing/checkoutCreate Stripe Checkout session

POST/api/v1/billing/portalGet Stripe Customer Portal URL

API Keys

POST/api/v1/keysCreate a new API key

GET/api/v1/keysList your API keys

DELETE/api/v1/keys/{id}Revoke an API key

Webhooks

POST/api/v1/webhooksRegister a webhook endpoint

GET/api/v1/webhooksList your webhooks

DELETE/api/v1/webhooks/{id}Delete a webhook

GET/api/v1/webhooks/{id}/deliveriesView delivery log

MCP Server (Model Context Protocol)

VectorEO exposes a read-only MCP server at /mcp for AI agent integration. Discovery via /.well-known/mcp.json.

Available MCP tools:

query — Semantic search across vectorized content
get_chunk — Retrieve a single chunk by ID
get_chunks — Retrieve multiple chunks by ID list
get_site_info — Site-level metadata (products, competitors, taxonomy)
list_topics — List all topics indexed for a site
filter_content — Filter by content type, audience, intent, topic
list_pages — Browse all crawled pages for a site
fetch_page — Retrieve full content for a specific page URL
list_custom_tools — List user-defined MCP tools for a site
run_custom_tool — Execute a custom MCP tool

See how AI-ready your site is

Free AI Readiness Scan checks 12 signals and scores your site from 0 to 100.

Scan Your Site Free