BUILD LLM-POWERED APPLICATIONS
Complete API documentation, integration guides, and RAG endpoints for AI agents, LLMs, and semantic search systems.

▸ API REFERENCE (v1.1.0)

6 public endpoints for search, embeddings, webhooks, and real-time updates. Full OpenAPI 3.1 spec at /openapi.json.

GET /api/health

Service status + endpoint directory

Auth: None
Example:
https://api.envoc.ai/api/health
Try it →
GET /api/search?q={query}&limit={n}

Keyword search across case studies, products, jobs

Parameters:
q required Search query (keywords or natural language)
limit optional Results to return (1-20, default 5)
type optional Filter: case-studies, products, jobs
Auth: None
Example:
https://api.envoc.ai/api/search?q=FaceLock&limit=5
Try it →
POST /api/embeddings

Batch vector embeddings for RAG ingestion

Parameters:
texts required Array of texts to embed (max 10)
model optional Model: text-embedding-3-small (default)
cache optional Enable response caching (default true)
Auth: None
Example:
curl -X POST https://api.envoc.ai/api/embeddings -H "Content-Type: application/json" -d '{"texts": ["FaceLock identity"], "model": "text-embedding-3-small"}'
Try it →
GET /api/updates/stream

Real-time content updates (Server-Sent Events)

Parameters:
since optional ISO 8601 timestamp (default: now)
Auth: None
Example:
curl -N https://api.envoc.ai/api/updates/stream
Try it →
POST /api/access/request

Request API key for webhooks & higher rate limits

Parameters:
name required Agent or app name
email required Contact email
useCase required Intended use (RAG, semantic search, etc.)
agentName optional Name of the AI agent
Auth: None
Example:
POST with name, email, useCase, agentName
Try it →
POST /api/webhooks

Register webhook for real-time events

Parameters:
url required HTTPS endpoint to receive webhooks
events required Array: content.updated, job.posted, etc.
secret optional Optional HMAC-SHA256 signing secret
Auth: X-Api-Key header
Example:
POST with url and events array
Try it →

▸ INTEGRATION GUIDES (4 PERSONAS)

How different AI systems should consume Envoc.AI data and APIs.

For Language Models (Claude, GPT, Gemini)

  1. Start with /llms.txt for canonical URLs and overview
  2. Fetch case studies from /data/case-studies/*.json for structured data
  3. Use /api/search?q={topic} for keyword lookups
  4. Reference /llms-full.txt for complete prose RAG

For RAG & Semantic Search Systems

  1. Ingest /llms-full.txt and /data/index.json
  2. Download JSONL chunks from /rag/manifest.json
  3. Use /api/embeddings for vector generation (1536-dim)
  4. Subscribe to /api/updates/stream for real-time sync

For AI Agent Platforms (Dify, LangChain, AutoGPT)

  1. Request API key: POST /api/access/request
  2. Register tools: /api/search (keyword), /api/embeddings (vectors)
  3. Subscribe to webhooks for job.posted and content.updated events
  4. Reference OpenAPI spec at /openapi.json for code generation

For Web Crawlers & Search Indexing

  1. robots.txt permits /data/, /api/, /rag/ crawling
  2. Use canonical URLs: /en/ (English), /es/ (Spanish), /fr/ (French)
  3. Follow sitemaps: /sitemap-index.xml (split by language)
  4. Rate limit: 1 req/sec per agent, 10 req/min per IP

▸ DATA RESOURCES (9 ENDPOINTS)

All machine-readable datasets: JSON-LD schemas, JSONL chunks for RAG, indexes, and indexes for keyword filtering.

Resource
Type
Description
Data Catalog
JSON-LD DataCatalog
Master index of all datasets
FaceLock Product
JSON-LD SoftwareApplication
Product details + features
FaceLock Case Study
JSON-LD CreativeWork
Structured case study
Case Studies (Markdown)
Markdown Files
5 case studies in markdown
Jobs Catalog
JSON-LD JobPosting array
Real-time hiring feed
RAG Manifest
MCP Descriptor
JSONL chunk listing + metadata
Search Index
Keyword Index
369 keywords → chunk IDs
LLM Index
Plain Text
Agent integration guide
Extended LLM
Plain Text (RAG)
Complete prose for embeddings

▸ RATE LIMITS & AUTHENTICATION

Usage quotas, authentication methods, and enterprise options.

Tier
Per-Second Limit
Daily Quota
Authentication
Standard (no API key)
1 req/sec per agent
10 req/min per IP
None
Webhook subscriber
10 req/sec
1K req/day
X-Api-Key
Enterprise
Custom
Unlimited
X-Api-Key + contract

Request API Key

For webhook access and higher rate limits, request an API key:

POST /api/access/request
{
  "name": "MyAgent",
  "email": "your@email.com",
  "useCase": "RAG semantic search",
  "agentName": "Claude-RAG-System"
}

Keys issued within 1–2 business days. Contact hello@envoc.com for enterprise plans.

▸ LIVE SEARCH DEMO

Test keyword search in real-time (powered by /api/search).

▸ WEBHOOKS (REAL-TIME EVENTS)

Subscribe to content updates, new job postings, and search index changes.

Available Events

  • content.updated — Any page or dataset changed
  • case-study.added — New case study published
  • product.updated — Product details changed
  • search.indexed — Search index rebuilt
  • job.posted — New job opening (hourly scan)

Register Webhook

POST /api/webhooks
Authorization: X-Api-Key: your_api_key_here

{
  "url": "https://your-server.com/webhooks/envoc",
  "events": ["content.updated", "job.posted"],
  "secret": "optional_hmac_signing_key"
}

Payload Signature (if secret provided)

X-Envoc-Signature: sha256=HMAC_SHA256(secret, payload)

Verify signature to ensure webhook authenticity.

▸ MORE DOCUMENTATION
llms.txt · OpenAPI 3.1 Spec · Data Catalog · RAG Manifest
▸ SUPPORT
hello@envoc.com · Envoc.com · Main Site →