API Documentation

Complete API reference for integrating CVG Neuron AI into your applications and workflows.

Note: API access requires a paid subscription (Starter tier or higher). Free tier users can access models via GitHub.

Authentication

Getting Your API Key

  1. Subscribe to Starter, Pro, Business, or Enterprise tier
  2. Access your dashboard at https://dashboard.cvg-neuron.cleargeo.tech
  3. Navigate to API Keys section
  4. Generate a new API key

Authentication Header

Authorization: Bearer YOUR_API_KEY_HERE

Base URL

https://api.cvg-neuron.cleargeo.tech/v1

Endpoints

POST /v1/chat

Interactive chat with CVG Neuron AI

Request:

{
  "query": "What's a typical timeline for coastal vulnerability assessment?",
  "context": "project_planning",
  "max_tokens": 2000,
  "temperature": 0.7,
  "include_sources": true
}

Response:

{
  "response": "Based on 47 similar coastal vulnerability projects...",
  "sources": [
    {"project_id": "CVG-2023-042", "relevance": 0.94},
    {"project_id": "CVG-2022-018", "relevance": 0.89}
  ],
  "confidence": 0.92,
  "tokens_used": 1247
}

POST /v1/analyze

Analyze project requirements and get recommendations

Request:

{
  "project_type": "flood_risk_assessment",
  "area_sqmi": 50,
  "client_type": "municipal",
  "budget_range": "50000-100000",
  "timeline_weeks": 12
}

Response:

{
  "feasibility": "high",
  "similar_projects": 23,
  "recommended_methodology": [...],
  "estimated_deliverables": [...],
  "risk_factors": [...],
  "success_probability": 0.87
}

POST /v1/generate

Generate proposals, reports, or technical documents

Request:

{
  "document_type": "proposal_methodology",
  "project_scope": "Coastal vulnerability assessment for 25-mile coastline",
  "client_context": "municipal_government",
  "include_sections": ["methodology", "timeline", "deliverables"],
  "format": "markdown"
}

Response:

{
  "document": "# Methodology\n\nBased on proven workflows...",
  "sections_included": ["methodology", "timeline", "deliverables"],
  "word_count": 2847,
  "based_on_projects": 15
}

GET /v1/projects

Search training project database

Parameters:

Example:

GET /v1/projects?query=flood&project_type=coastal&year=2024&limit=10

Client Libraries

Python

pip install cvg-neuron

from cvg_neuron import NeuronClient

client = NeuronClient(api_key="your-key")
response = client.chat("How do I structure a flood analysis proposal?")
print(response.text)

JavaScript/TypeScript

npm install @cvg/neuron-sdk

import { NeuronClient } from '@cvg/neuron-sdk';

const client = new NeuronClient({ apiKey: 'your-key' });
const response = await client.chat({
  query: 'Timeline for environmental assessment?'
});
console.log(response.text);

cURL

curl -X POST https://api.cvg-neuron.cleargeo.tech/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "Best practices for stakeholder engagement?",
    "context": "project_management"
  }'

Rate Limits

Tier Requests/Hour Tokens/Month
Starter 100 1M
Pro 500 10M
Business 2000 50M
Enterprise Custom Unlimited

Error Codes

Webhooks (Enterprise Only)

Configure webhooks to receive notifications for long-running analysis:

POST /v1/webhooks/register
{
  "url": "https://your-domain.com/webhook",
  "events": ["analysis_complete", "report_ready"],
  "secret": "your-webhook-secret"
}

Support

Need help with API integration? Contact us:

Get API Access →