Developers · API Reference

API Reference

Build Nous AI into your own applications: grounded, natural-language answers over your own knowledge base.

Base URL

The base URL for all API requests is: https://{your_subdomain}.nousai.com. You can use the subdomain provided to you by Nous AI.

Your subdomain identifies your tenant, and a key is only valid against its own subdomain. Sending a valid key to a different subdomain is rejected.

Authentication

Every endpoint requires API key authentication. Send the x-api-key provided to you by Nous AI on each request. There is no token exchange and no expiry: the key is the credential.

Example Request
curl -X POST https://{your_subdomain}.nousai.com/api/v1/search/ \
	-H "x-api-key: {your_api_key}" \
	-H "Content-Type: application/json" \
	-d '{"query": "What was EMEA revenue in Q3?"}'

Keeping your key safe

A key carries the access rights of your tenant, so it belongs on your server, not in a browser or a mobile app. Ask Nous AI to deactivate a key you believe is exposed: a deactivated key stops working immediately.

Errors

Errors carry an HTTP status and a JSON body. These are common to every API; each API's page documents the codes specific to its endpoints.

CodeMeaningContent
400The request was understood but a parameter is missing or invalid{"detail": "..."} or the offending field
403The x-api-key header is missing, unknown, deactivated, or belongs to another tenant{"detail": "Invalid API key"}
404The addressed resource does not exist for this key{"error": "..."}
502The request reached us but could not be completed{"error": "..."}