API Reference

The Synaptic API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes.

Bearer Authentication

Use your secret API key in the Authorization header to authenticate requests.

HTTPS Only

All API requests must be made over HTTPS for security and data integrity.

Quickstart Example

# Get all profiles
curl -X GET "https://api.synaptic.ai/v1/profiles" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"

Core Endpoints

GET /v1/profiles

Retrieve a list of all employee profiles within your organization.

Details

POST /v1/profiles

Create a new employee profile with custom metadata and skill tags.

Details

GET /v1/neural-graph

Fetch the latest organizational neural graph and connectivity weights.

Details

POST /v1/events

Push custom events (performance, feedback, etc.) to the neural engine.

Details

Neural Engine Webhooks

Receive real-time notifications when significant shifts occur in your organizational neural graph or when potential attrition risk is detected.