API referenceVerify API key GET
Verify API key
Check that an API key works and its account has an active subscription.
The call doesn't use quota but counts toward your rate limit. It also returns the NeuroAPI build version, for example to show in a build banner.
GET
/healthAuthorization
APIKeyHeader X-API-Key<token>
In: header
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.neurobro.ai/api/v1/health"{
"authenticated": true,
"key_prefix": "neuro_a1b2c3d4e5",
"service": "neuroapi",
"status": "healthy",
"timestamp": "2026-05-08T12:34:56.789Z",
"version": "0.1.0"
}{
"detail": "Invalid API key"
}{
"detail": {
"code": "mode_not_in_plan",
"message": "Mode 'max' is not available on the 'starter' plan. Upgrade to access it."
}
}{
"detail": {
"code": "mode_not_in_plan",
"message": "Mode 'max' is not available on the 'starter' plan. Upgrade to access it."
}
}{
"detail": {
"code": "mode_not_in_plan",
"message": "Mode 'max' is not available on the 'starter' plan. Upgrade to access it."
}
}Ask the agent POST
Send a market research question and get the answer as one JSON document, or as a server-sent event (SSE) stream when stream=true.
Examples
Copy-paste recipes for Q&A, multi-turn chat, streaming, retries, mode selection, system prompts, structured output, and a thin TypeScript client.