API Reference

The NeuralSnap REST API lets you create, read, update, and delete Neural Snapshots, run semantic search across your brain, crystallise raw text into structured knowledge, and check your account usage — all from any language or platform that speaks HTTP.

Base URL

All API requests are made to the following base URL:

https://neuralsnap.ai/api/v1

Authentication

Every request must include a Bearer token in the Authorization header. You can generate API keys from your dashboard.

bash

Authorization: Bearer ns_live_abc123...

Content Type

All request and response bodies are JSON. Set the Content-Type header accordingly:

bash

Content-Type: application/json

Rate Limits

Rate limits are enforced per API key on a rolling one-hour window.

Property	Type	Description
`Starter`	plan	100 requests per hour
`Pro`	plan	1,000 requests per hour
`Business`	plan	10,000 requests per hour

When you exceed the limit, the API returns 429 Too Many Requests. Check the X-RateLimit-Remaining response header to monitor your usage.

Error Format

All error responses follow a consistent JSON structure:

json

{
  "error": "Human-readable error message",
  "code": "OPTIONAL_ERROR_CODE"
}

HTTP Status Codes

The API uses standard HTTP status codes to indicate success or failure:

Property	Type	Description
`200`	OK	Request succeeded. Response body contains the requested data.
`201`	Created	Resource created successfully. Returned by POST endpoints.
`400`	Bad Request	Invalid request body or missing required parameters.
`401`	Unauthorized	Missing or invalid API key.
`403`	Forbidden	Valid key but insufficient permissions for this action.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded. Back off and retry after the reset window.
`500`	Internal Server Error	Something went wrong on our end. Contact support if it persists.

Test API Keys

All code examples in this documentation use test API keys (e.g. ns_test_abc123). Replace them with your own key from the dashboard before making real requests.

Crystallization Guide

Authentication