API Reference

Integrate DocEngine into your workflows with our RESTful API

Base URL

https://api.docengine.dev/api/v1

Authentication

All API requests require a Bearer token in the Authorization header. Obtain a token by authenticating through the /auth/login endpoint.

Authorization: Bearer <your-access-token>

Authentication

POST /auth/login

Authenticate and receive an access token.

POST /auth/register

Create a new user account.

POST /auth/refresh-token

Refresh an expired access token.

Organizations

GET /organizations

List all organizations for the authenticated user.

POST /organizations

Create a new organization.

GET /organizations/{id}

Get organization details by ID.

Workspaces

GET /workspaces

List workspaces in the current organization.

POST /workspaces

Create a new workspace.

Projects

GET /projects

List projects in the current workspace.

POST /projects

Create a new project.

GET /projects/{id}

Get project details including documents and tasks.

Documents

GET /documents

List documents in a project.

POST /documents/generate

Generate a new BRD from plain-text requirements using AI.

POST /documents/{id}/derive

Derive a child document (SRD, FRS, Epics, Stories) from an existing BRD.

GET /documents/{id}/export

Export a document as PDF, Word, Excel, or Markdown.

POST /documents/{id}/share

Generate a secure share link for the document.

Quality

POST /documents/{id}/quality-score

Run quality analysis on a document and receive a score with per-section breakdown.

Knowledge Graph

GET /projects/{id}/knowledge-graph

Retrieve the knowledge graph for a project including entities and relationships.

GET /projects/{id}/impact-analysis

Run impact analysis to understand the effect of changes across documents and tasks.