Skip to main content
← Back to Docs

API Reference

85+ REST endpoints. Base URL: https://brain.api.vauban.tech

All endpoints return { success, data, meta?, error? }. Pagination via limit + offset.

Authentication Methods

JWTSession token from /auth/verify. Header: Authorization: Bearer ...
KeyAPI key from /v1/keys. Header: X-API-Key: sk_...
AdminAdmin key. Header: X-Admin-Key: ...
NonePublic endpoint, no auth required

Health & Monitoring

Liveness probes and system status.

MethodPathAuthDescription
GET/healthNoneLiveness probe — uptime, version
GET/health/statsNoneFull status with knowledge stats
GET/metricsNonePrometheus-compatible metrics

Authentication

Wallet SNIP-12, OAuth (GitHub, Google), JWT tokens.

MethodPathAuthDescription
POST/auth/challengeNoneGenerate SNIP-12 wallet challenge
POST/auth/verifyNoneVerify wallet signature, returns JWT
GET/auth/meJWTCurrent user info + brains
POST/auth/linkJWTLink OAuth identity to wallet
GET/auth/linksJWTList identity links
GET/auth/providersNoneAvailable auth providers
GET/auth/githubNoneRedirect to GitHub OAuth
GET/auth/github/callbackNoneGitHub OAuth callback
GET/auth/googleNoneRedirect to Google OAuth
GET/auth/google/callbackNoneGoogle OAuth callback

Knowledge

Core CRUD, full-text search, anchoring, graph traversal.

MethodPathAuthDescription
POST/api/knowledgeJWT/KeyCreate knowledge entry
GET/api/knowledgeOptionalQuery with FTS + filters (?q, ?category, ?tags, ?limit, ?offset, ?brain_ids, ?confidence_min)
GET/api/knowledge/:idOptionalGet entry by ID + edges
PATCH/api/knowledge/:idJWT/KeyUpdate entry (partial)
GET/api/knowledge/:id/versionsOptionalVersion history
GET/api/knowledge/:id/graphOptionalGraph traversal (?depth=1-3)
POST/api/knowledge/edgesJWT/KeyCreate edge (source_id, target_id, edge_type)
POST/api/knowledge/:id/anchorJWT/KeyAnchor to Starknet (?format=vc)
GET/api/knowledge/search/hybridOptionalHybrid FTS + semantic search (?q, ?limit)
GET/api/knowledge/graph/overviewOptionalFull graph overview (?limit, ?brain_id)
PATCH/api/knowledge/:id/memory-classJWT/KeyReclassify entry epistemic type (fact, opinion, hypothesis)

Cognitive Pipeline (V4.1)

Proactive cognition, contradictions, spreading activation, analogical reasoning, feedback signals.

MethodPathAuthDescription
GET/api/cognitive/taxonomyNoneEpistemic taxonomy rules (fact/opinion/hypothesis)
GET/api/cognitive/proactive/statusOptionalProactive cognition monitoring — last runs, budget
GET/api/cognitive/proactive/foresightOptionalForesight edges with survival rate
GET/api/cognitive/proactive/dialecticalOptionalDialectical syntheses with promotion rate
GET/api/cognitive/contradictions/listOptionalContradictions with status/type filters (?status, ?type, ?limit)
GET/api/cognitive/contradictions/:idOptionalFull contradiction detail — entries, evidence, resolution
PATCH/api/cognitive/contradictions/:idJWT/KeyResolve contradiction (admin — verdict + rationale)
POST/api/brain/contextJWT/KeyFoA cognitive pipeline — full fluid intelligence query
GET/api/retrieval-proofsOptionalList retrieval proofs
GET/api/proof/retrieval/:idOptionalProof details + on-chain status
GET/api/proof/:id/vcOptionalW3C VerifiableCredential output

Brains & Workspaces

Multi-tenant knowledge workspaces with member management.

MethodPathAuthDescription
POST/api/brainsJWTCreate brain
GET/api/brainsJWTList user brains
GET/api/brains/:idJWTGet brain detail + members
PATCH/api/brains/:idJWTUpdate brain settings (owner/admin)
POST/api/brains/:id/membersJWTAdd member
DELETE/api/brains/:id/members/:accountIdJWTRemove member

API Keys

Create, list, rotate, and revoke API keys.

MethodPathAuthDescription
POST/v1/keysJWTCreate API key
GET/v1/keysJWTList keys (no raw values)
POST/v1/keys/:id/rotateJWTRotate key (new secret, same ID)
DELETE/v1/keys/:idJWTRevoke key

Agents

Agent telemetry — log task executions, track cost.

MethodPathAuthDescription
POST/api/agents/tasksJWTLog agent task execution
GET/api/agents/statsJWTAggregated agent stats + cost
GET/api/agents/:name/tasksJWTAgent task history (?limit, ?offset, ?status)

Development Intelligence

Pattern suggestion, anti-pattern detection, architecture analysis.

MethodPathAuthDescription
POST/api/development/suggest-patternsJWTSuggest design patterns for code
POST/api/development/detect-antipatternsJWTDetect anti-patterns + vulnerabilities
POST/api/development/architectural-adviceJWTArchitecture recommendations
POST/api/development/realtime-analysisJWTFull real-time analysis
GET/api/development/healthNonePattern intelligence health

Billing & Subscriptions

Stripe integration for paid tiers.

MethodPathAuthDescription
GET/api/billing/pricesNonePublic pricing info
POST/api/billing/checkoutJWTCreate Stripe checkout session
POST/api/billing/portalJWTCustomer portal URL
GET/api/billing/subscriptionJWTCurrent subscription

Usage & Quotas

Request metering with tier-based limits.

MethodPathAuthDescription
GET/api/usageJWTAccount usage for last N days (?days=30)

Organizations

Team workspaces with RBAC, SSO, audit logs.

MethodPathAuthDescription
POST/api/organizationsJWTCreate organization
GET/api/organizationsJWTList user organizations
GET/api/organizations/:idJWTOrganization details
POST/api/organizations/:id/membersJWTAdd member (admin)
DELETE/api/organizations/:id/members/:accountIdJWTRemove member
GET/api/organizations/:id/audit-logsJWTAudit logs (?limit, ?offset)
POST/api/organizations/:id/sso/configureJWTConfigure SSO (owner)

Analytics

Velocity compounding, pattern success rates, ROI analysis.

MethodPathAuthDescription
GET/api/analytics/velocityJWTVelocity analytics (?project_id, ?period)
GET/api/analytics/patterns/successJWTPattern success metrics
GET/api/analytics/qualityJWTQuality metrics
GET/api/analytics/roiJWTROI analysis (?period, ?hourly_rate)
GET/api/analytics/dashboardJWTComprehensive dashboard
GET/api/analytics/velocity/trendsJWTVelocity trends (?periods=6)
GET/api/analytics/velocity/forecastJWTVelocity forecast + compounding

Marketplace

Knowledge marketplace with escrow protection.

MethodPathAuthDescription
GET/api/marketplaceNoneBrowse listings (?category, ?limit)
POST/api/marketplaceKeyCreate listing
GET/api/marketplace/patternsNoneSearch public patterns
POST/api/marketplace/patternsJWTPublish pattern
POST/api/marketplace/patterns/:id/downloadJWTDownload pattern

Sync & Export

Cross-instance knowledge synchronization.

MethodPathAuthDescription
POST/api/sync/pushJWTPush knowledge to target instance
GET/api/sync/exportJWTExport entries for sync (?categories, ?since, ?limit)
POST/api/sync/importJWTImport entry from external
GET/api/sync/statusJWTSync status

Admin

Administrative operations (X-Admin-Key auth).

MethodPathAuthDescription
POST/api/admin/keysAdminCreate API key (admin)
GET/api/admin/keysAdminList all API keys
DELETE/api/admin/keys/:idAdminRevoke key (admin)
GET/api/admin/usage/:keyIdAdminUsage stats for key (?hours=24)

Rate Limits & Quotas

TierPriceDaily RequestsFeatures
Free$01,0001 brain, SQLite local, no proofs
Pro$29/mo10,0005 brains, cloud sync, Starknet proofs
Team$99/mo100,000Unlimited brains, RBAC, 5 members, encrypted

Quota headers: X-Quota-Remaining, X-Quota-Limit, X-Quota-Reset

ESC
Navigation
Admin
Docs
↑↓NavigateSelectescClose
API Reference — Brain Protocol | Brain Protocol