BoardPulse AI REST API — complete endpoint reference - BoardPulse AI

The BoardPulse AI REST API lets you submit natural-language questions, inspect workspace schemas, download query results, and connect OpenAI-compatible clients — all over HTTP. Every endpoint is versioned under /api/v1/ and returns JSON.

Base URL

The default base URL is:

http://localhost:8000/api/v1

You can change the host and port through environment variables:

Variable	Default	Description
`APP_HOST`	`0.0.0.0`	Host the server binds to
`APP_PORT`	`8000`	Port the server listens on
`API_V1_PREFIX`	`/api/v1`	Prefix for all v1 endpoints

Available endpoints

Method	Path	Description
`GET`	`/api/v1/health`	Returns the service status and current environment
`POST`	`/api/v1/chat/query`	Submits a natural-language question and returns an answer, SQL, table, chart, and exports
`GET`	`/api/v1/workspaces/{workspace_id}/source`	Returns the data source configuration for a workspace
`POST`	`/api/v1/workspaces/{workspace_id}/test-connection`	Tests the database connection for a workspace
`GET`	`/api/v1/workspaces/{workspace_id}/schema`	Returns the full table and column schema for a workspace
`GET`	`/api/v1/exports/{filename}`	Downloads a previously generated CSV or XLSX export file
`GET`	`/openai/v1/models`	Lists available models for the OpenAI-compatible endpoint
`POST`	`/openai/v1/chat/completions`	Submits a query using the OpenAI ChatCompletion format

Interactive docs

FastAPI generates a Swagger UI at http://localhost:8000/docs. You can use it to explore and test every endpoint directly in your browser without writing any code.

Authentication

The main /api/v1/ endpoints require no authentication in the current MVP release. The OpenAI-compatible endpoints under /openai/v1/ require a Bearer token. See Authentication for details.

Powered by Mintlify

Auto-generate your docs