API reference

Authentication

How to send your API key and what every request needs

Every request needs an API key in the Authorization header; a bad or missing key returns 401 UNAUTHORIZED.

Authorization: Bearer nph_...

Send identifier on every call: in the JSON body on POST, as ?identifier= on GET and DELETE. Missing it returns 400 VALIDATION_ERROR; see Get started > Identifiers.

How to keep keys safe and what can fail beyond authentication are under Get started > API keys.

Example

curl

curl https://api.neurophic.ai/v1/retrieve \
  -H "Authorization: Bearer nph_..." \
  -H "Content-Type: application/json" \
  -d '{"identifier":"user-123","query":"travel preferences"}'

Overview

How to call the API and what every request needs

Errors

The error envelope and every code the API returns