API Reference
API Overview
The NeuronEdge API is organized around REST. Our API accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes and authentication.
Base URL
https://api.neuronedge.aiAuthentication
All API requests require authentication via Bearer token in the Authorization header. API keys are prefixed with ne_ to distinguish them from provider keys.
Authorization: Bearer ne_live_your_api_key
X-Provider-API-Key: sk-your-provider-keyRequest Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | NeuronEdge API key (ne_...) |
| X-Provider-API-Key | Yes | Your LLM provider API key |
| X-NeuronEdge-Policy | No | Policy ID to override default |
| X-NeuronEdge-Format | No | Redaction format: token, hash, synthetic |
| X-NeuronEdge-Mode | No | Detection mode: real-time, balanced, thorough |
| X-NeuronEdge-Entities | No | Comma-separated entity types to detect |
Response Headers
| Header | Description |
|---|---|
| X-Request-ID | Unique request identifier (ULID format) |
| X-NeuronEdge-Entities-Detected | Number of PII entities detected |
| X-NeuronEdge-Detection-Time-Ms | Detection processing time in milliseconds |
| X-RateLimit-Limit | Your rate limit ceiling |
| X-RateLimit-Remaining | Remaining requests in current window |
| X-RateLimit-Reset | Unix timestamp when limit resets |
| X-NeuronEdge-Response-Entities-Detected | Number of PII entities detected in LLM response |
| X-NeuronEdge-Prompt-Injection-Score | Prompt injection detection confidence score (0.0-1.0) |
Endpoints
/v1/{provider}/chat/completionsSend chat completion requests with automatic PII redaction
/api/policiesList all policies for your organization
/api/policiesCreate a new PII detection policy
/api/keysList all API keys for your organization
/healthHealth check endpoint (no auth required)
/api/reports/complianceGenerate compliance reports with framework-specific attestations
/api/alerts/rulesCreate and manage PII-aware alert rules with webhook delivery
/api/analytics/streamReal-time SSE stream of entity detection events
/api/patternsManage custom regex patterns with versioning and test bench
/api/workspacesCreate and manage multi-tenant workspaces within your organization
/api/policies/from-templateCreate a policy from a compliance template (HIPAA, PCI-DSS, SOC 2, FINRA, FedRAMP)
Supported Providers
NeuronEdge supports 17 LLM providers through the /v1/{provider}/chat/completions endpoint:
openaianthropicgoogleazurecohereperplexitygroqmistraltogetherfireworksanyscaledeepinfrahuggingfacereplicatebedrockbasetenai21