API overview

Everything the dashboard does goes through a REST API — which means anything you can click, you can script. Use it to automate ingestion, wire Insight AI into your own tools, or give an AI agent programmatic access to your organization’s knowledge base.

Base URL

Environment	Base URL
Hosted	https://dashboard.insightai.pro/api/v1
Self-hosted	http://localhost:8000/api/v1 (adjust host/port to your instance)

All examples in this section use a $BASE variable:

export BASE=https://dashboard.insightai.pro/api/v1

Interactive API explorer

A self-hosted instance serves machine-readable and interactive docs straight from the backend: Swagger UI at /docs, ReDoc at /redoc, and the raw OpenAPI schema at /openapi.json (all at the server root, not under /api/v1). These are the authoritative, always-current reference for every endpoint and schema; the pages here focus on the operations and workflows you’ll actually build against.

Conventions

• Requests and responses are JSON (Content-Type: application/json).
• Every resource is identified by a UUID ("id" fields).
• Timestamps are ISO-8601.
• Authentication uses a JWT — sent either as a cookie or a Bearer token — valid for 24 hours.

Errors

Errors use conventional HTTP status codes with a JSON body:

{ "detail": "Invalid SMB credentials" }

Status	Meaning
400	Invalid input — the detail string explains what
401	Missing or expired token
404	Resource (or model) not found
409	Conflict — e.g. an ingestion is already running, or a user is already in a group
422	Request body failed validation — detail lists the offending fields
503	An upstream dependency (e.g. the SMB server) is unreachable

Resource map

Area	Endpoints	Covered in
Auth & users	/signup, /signin, /signout, /users…	Authentication
Groups	/user_groups…	Data & ingestion
Data sources	/data_sources…	Data & ingestion
Collections	/collections…	Data & ingestion
Pipelines & ingestion	/data_pipelines…	Data & ingestion
Chat	/chats…	Chat API
Models	/models…	Models API