API Overview

The NeuralRepo API is a RESTful JSON API that lets you programmatically manage ideas, tags, relations, and user settings.

Base URL

All API requests are made to:

https://neuralrepo.com/api/v1

The API is versioned through the URL path. The current (and only) version is v1.

Content Type

All request and response bodies use JSON. Set the Content-Type header on every request that includes a body:

Content-Type: application/json

Authentication

Every endpoint except /api/v1/health requires authentication. You can authenticate using either method:

Method	Header	Format
Session token	Authorization	Bearer <session_token>
API key	X-API-Key	nrp_<64 hex characters>

See Authentication for details on generating keys and managing scopes.

Pagination

List endpoints accept limit and offset query parameters:

Parameter	Default	Max	Description
limit	20	100	Number of items to return
offset	0	—	Number of items to skip

Example:

GET /api/v1/ideas?limit=50&offset=100

Response Format

All responses return JSON. Successful responses return the resource directly or an array of resources. Error responses return an object with an error field:

{
  "error": "Not found"
}

Rate Limiting

Requests are rate-limited on a per-user basis. When you exceed the limit, the API responds with 429 Too Many Requests. See Rate Limits for details on retry behavior.

Health Check

The health endpoint is the only unauthenticated route. Use it to verify the API is reachable:

curl

curl https://neuralrepo.com/api/v1/health

JavaScript

const res = await fetch("https://neuralrepo.com/api/v1/health");
const data = await res.json();
console.log(data);

Response 200 OK

{
  "status": "ok",
  "timestamp": "2026-03-25T12:00:00Z"
}

Versioning

The API is currently at v1. Breaking changes will be introduced under a new version prefix (e.g., /api/v2). Non-breaking additions (new fields, new optional parameters) may be added to v1 at any time.

Quick Reference

Resource	Endpoints
Ideas	GET POST PATCH DELETE /ideas
Search	GET /ideas/search
Duplicates	GET /ideas/duplicates
Tags	GET POST PATCH DELETE /tags
Links	GET POST DELETE /ideas/:id/links
Relations & Graph	GET /ideas/:id/relations, /map/relations
Mind Map	GET /map
User & Settings	GET PATCH /user/me, BYOK, export
Export	POST /user/export, POST /user/export/csv