Skip to main content

API documentation

Who can do this: Admins and Owners (the reference is aimed at the developers they work with).

Settings → API Docs is the built-in developer reference for integrating RefineAI Answers into your own systems.

The in-app API reference

What's covered​

  • the base URL for your organisation's API,
  • authentication — requests carry an API key as a bearer token,
  • the available endpoints (asking questions, search, document ingestion) with example requests and responses,
  • rate limits and how they interact with your plan's API call allowance.

Typical integrations​

  • Ask from where people already work — an intranet page or internal tool that sends questions to the API and renders the cited answer.
  • Automatic ingestion — a pipeline that uploads new or updated documents so the knowledge base stays current without anyone clicking Upload.

Questions asked via API appear in Query Logs with an API source badge, and count towards the monthly API allowance shown in Organisation settings.

Next: Extraction settings →