API Documentation v1.0.0

Complete reference for the DocForge document conversion API. All endpoints accept JSON and return JSON.

https://docforge-api.vercel.app

Authentication

Pass your API key via the X-Api-Key header. The Free tier requires no key.

Tier	Key Prefix	Requests/Day	Max Input	Price
Free	none	500	100 KB	$0
Pro	`dk_pro_*`	50,000	5 MB	$9/mo
Team	`dk_team_*`	500,000	25 MB	$29/mo

API Key for "Try it" requests:

GET /api/index

API Directory

Returns the API name, version, operational status, and a list of all available endpoints. No authentication required.

Response Body

Field	Type	Description
name	string	API name
version	string	API version
status	string	Operational status
endpoints[]	object[]	Array of endpoint objects with `method`, `path`, `description`

Try it out ▶

Click "Send Request" to see the response

POST /api/md-to-html

Markdown to HTML

Convert Markdown text to sanitized HTML. Supports headings (h1-h6), bold, italic, strikethrough, links, images, fenced code blocks with language annotation, ordered and unordered lists, blockquotes, and horizontal rules.

Request Body

Field	Type		Description
markdown	string	required	Markdown text to convert (min 1 character)

Response Body

Field	Type	Description
html	string	Rendered HTML output
meta.wordCount	integer	Number of words in the input
meta.headings	string[]	Extracted heading text

Try it out ▶

Click "Send Request" to see the response

POST /api/csv-to-json

CSV to JSON

Parse CSV (or TSV) data into a JSON array of objects. The first row is treated as column headers. Supports quoted fields with escaped double-quotes and a configurable single-character delimiter.

Request Body

Field	Type		Description
csv	string	required	CSV text to parse (min 1 character)
delimiter	string	optional	Single-character delimiter. Default: `,`

Response Body

Field	Type	Description
data	object[]	Array of row objects keyed by column headers
meta.rowCount	integer	Number of data rows (excluding header)
meta.columns	string[]	Column names from the header row

Try it out ▶

Click "Send Request" to see the response

POST /api/json-to-csv

JSON to CSV

Convert an array of JSON objects to CSV format. Columns are automatically detected from all keys across all rows. Fields containing the delimiter, double quotes, or newlines are properly escaped. Supports a configurable delimiter.

Request Body

Field	Type		Description
data	object[]	required	Non-empty array of JSON objects to convert
delimiter	string	optional	Single-character delimiter. Default: `,`

Response Body

Field	Type	Description
csv	string	CSV output with header row and data rows
meta.rowCount	integer	Number of data rows
meta.columns	string[]	Column names (union of all keys)

Try it out ▶

Click "Send Request" to see the response

POST /api/yaml-json

YAML / JSON Conversion

Bidirectional conversion between YAML and JSON. Set direction to yaml-to-json or json-to-yaml. The YAML parser supports scalars, nested objects, and arrays.

Request Body

Field	Type		Description
input	string	required	The YAML or JSON string to convert (min 1 character)
direction	enum	required	`yaml-to-json` or `json-to-yaml`

Response Body

Field	Type	Description
output	string	The converted output (JSON string or YAML string)
meta.keys	integer	Number of top-level keys in the parsed object

Try it out ▶

Click "Send Request" to see the response

Error Codes

All errors return a consistent JSON structure. The code field is machine-readable and stable across versions.

HTTP Status	Code	Description
400	INVALID_INPUT	Request body is missing required fields, has invalid types, or fails Zod validation
400	PARSE_ERROR	The input could not be parsed (malformed JSON, invalid YAML, etc.)
405	INVALID_INPUT	HTTP method not allowed (only POST is accepted on conversion endpoints)
413	INPUT_TOO_LARGE	Request body exceeds the tier's maximum input size
429	RATE_LIMITED	Daily request limit exceeded for the current tier
500	INTERNAL_ERROR	Unexpected server error during processing

Error Response Shape

{
  "error": "Human-readable error message",
  "code": "INVALID_INPUT",
  "details": "Optional additional context"
}

Download the full OpenAPI 3.0 spec (JSON) for code generation, Postman import, or CI integration.