API Referencequery

Execute Query

Talk to your data! Execute a query against the database using DeepQuery v1. Database ID and environment are looked up automatically from API key + database_name. Headers: - Authorization: Bearer {api_key} - Captain API key for authentication - X-Organization-ID: Organization UUID - Idempotency-Key: UUID for request deduplication (optional) Parameters: - query: The natural language query - database_name: Name of the database to query - include_files: Whether to include relevant files in the response (default: False) - stream: Enable real-time streaming via S2 (default: False) Authentication: Requires valid API key in Authorization header Returns: 404 if database not found or has been deleted

Headers

AuthorizationstringRequired
Captain API key for authentication
X-Organization-IDstringRequired
Organization UUID

Request

This endpoint expects an object.
querystringRequired
database_namestringRequired
include_filesboolean or nullOptionalDefaults to false
Include relevant file information in the response
streamboolean or nullOptionalDefaults to false

Enable streaming response via Server-Sent Events (SSE)

inferenceboolean or nullOptionalDefaults to true

Enable LLM inference to generate AI-powered answers. When disabled, returns raw search results for custom RAG pipelines.

topKinteger or nullOptionalDefaults to 80
Number of top results to return from the search

Response

Successful Response

Errors