Developer API

docuQ Developer API

Turn your knowledge bases into a precise question-answering engine. Ingest documents, run hybrid retrieval, and get answers that are always traced back to their source — all over a small, predictable REST API.

Base URLhttp://localhost:3000/api/v1

Use http://localhost:3000 for local development. In production, replace the origin with your deployment’s URL — every endpoint lives under /api/v1.

Core concepts

Four primitives are all you need to understand the platform.

API keys

A personal access token (dq_live_…) that authenticates every request and inherits its owner’s knowledge-base access.

Knowledge bases

Named collections of documents. Each request is scoped to the KBs your key can reach — owned plus shared read-only.

Documents

Text or markdown you ingest into a KB. docuQ chunks and embeds them so they become searchable context.

Query (RAG)

Ask a natural-language question. Hybrid retrieval finds the right chunks and DeepSeek answers with inline citations.

The mental model

Three steps take you from zero to cited answers.

  1. 01

    Create a key

    Mint an API key in the app under Settings → API Keys. It is shown once — store it safely.

    Getting started
  2. 02

    Add documents

    Create a knowledge base, then POST raw text or markdown into it. docuQ indexes it automatically.

    Documents API
  3. 03

    Query

    Send a question to /query. Get back a grounded answer plus the citations it was built from.

    Query API

What you can build

  • Internal Q&A bots over your team’s docs, runbooks, and policies
  • Citation-backed answer widgets embedded in your own product
  • Automated research assistants that pull from curated knowledge bases
  • Pipelines that ingest text/markdown and expose it as a queryable API

Ready to start?

Follow the quickstart to mint a key and run your first query, or jump straight into the full endpoint reference.