Guide & Documentation

Everything you need to know about using Writ (QuikDB) — from creating your first document to building API integrations.

1. Getting Started

Create an Account

Sign up at writ.quikdb.com/signup with your email address. You can start using Writ immediately on the free plan.

  1. Enter your name, email, and password
  2. Verify your email address
  3. You are taken to your dashboard — start creating

Your Dashboard

The dashboard is your home base. From here you can create new documents and spreadsheets, view recent files, manage folders, send documents for signature, and access your settings.

Keyboard Shortcuts

BoldCtrl+B
ItalicCtrl+I
UnderlineCtrl+U
UndoCtrl+Z
RedoCtrl+Shift+Z
SaveCtrl+S

Use AI to build integrations

Throughout this guide, look for the AI Integration Prompt blocks in each section. Copy the prompt and paste it into ChatGPT, Claude, or any AI coding tool — it contains the exact API specification so the AI can write working code for you in any language. No need to read the full API docs yourself.

2. Documents

Creating a Document

Click "New Document" from the dashboard or navigate to the editor directly. Documents are auto-saved as you type.

You can also start from a template — browse the template gallery for contracts, NDAs, invoices, and more.

Rich Text Editor

The editor supports full rich text formatting powered by TipTap:

  • Headings (H1 through H6)
  • Bold, italic, underline, strikethrough
  • Text color and highlighting
  • Font family selection
  • Ordered and unordered lists
  • Task lists with checkboxes
  • Tables
  • Images
  • Links
  • Math equations (KaTeX)
  • Code blocks
  • Text alignment (left, center, right, justify)

Exporting Documents

Export your documents in multiple formats:

  • PDF — Print-ready, preserves formatting
  • DOCX — Microsoft Word compatible
  • HTML — Web-ready
  • Plain Text — No formatting

Importing Documents

Upload existing documents from your computer. Supported formats include DOCX, PDF, and TXT files. The content is automatically converted to the editor format.

AI Integration Prompt — Documents

Copy this prompt and paste it into ChatGPT, Claude, or any AI coding assistant. It contains the full API spec so the AI can write working integration code for you.

I need to integrate with the Writ (QuikDB Notes) Documents API. Here is the full API spec:

Base URL: https://notes.quikdb.com/api/v1
Auth: Bearer token in Authorization header (API key starts with "quikdb_")

ENDPOINTS:
- GET /documents — List documents. Query params: limit (default 50), offset, folderId
- POST /documents — Create document. Body: { title, content?, html?, format? ("markdown"|"text"), folderId? }. Returns { id }
- GET /documents/:id — Get document with metadata + content. Query: ?format=html for raw HTML
- PUT /documents/:id — Update document. Body: { title?, content?, html?, status?, folderId? }
- DELETE /documents/:id — Delete document permanently
- GET /documents/:id/content — Get raw TipTap JSON content
- PUT /documents/:id/content — Replace content. Body: { content (TipTap JSON), html }
- PATCH /documents/:id/content — Append nodes (Paid). Body: { append: [TipTap nodes] }
- POST /documents/:id/share — Share (Paid). Body: { email, permission: "view"|"edit_doc"|"edit_full" }
- DELETE /documents/:id/share — Unshare. Query: ?email=user@example.com

Rate limits: 30 req/min (free), 100 req/min (paid)
Free tier: 5 documents/month. Paid: 500/month.

EXAMPLE — Create and read a document:
curl -X POST https://notes.quikdb.com/api/v1/documents \
  -H "Authorization: Bearer quikdb_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Meeting Notes", "content": "# Agenda\n- Item 1", "format": "markdown"}'

Please write code to [DESCRIBE YOUR TASK HERE]. Use my API key from the environment variable QUIKDB_API_KEY.

3. Spreadsheets

Creating a Spreadsheet

Click "New Spreadsheet" from the dashboard. Each spreadsheet can contain multiple sheets (tabs), just like Google Sheets or Excel.

Spreadsheets are powered by the Univer engine and support 400+ formulas, cell formatting, and large datasets.

Working with Cells

Click any cell to start editing. Use Tab to move right, Enter to move down. Select ranges by clicking and dragging.

Cell references use A1 notation (e.g., A1, B2:D10). Formulas start with =.

Formulas

400+ built-in formulas including:

=SUM(A1:A10) — Add values
=AVERAGE(B1:B5) — Mean
=IF(A1>10,"Yes","No") — Conditional
=VLOOKUP(...) — Lookup
=COUNT(A:A) — Count
=CONCATENATE(A1,B1) — Join text

Import & Export

Import data from CSV or JSON files. Export your spreadsheets as CSV or JSON. XLSX export is coming soon.

AI Integration Prompt — Spreadsheets

Copy this prompt and paste it into ChatGPT, Claude, or any AI coding assistant. It contains the full API spec so the AI can write working integration code for you.

I need to integrate with the Writ (QuikDB Notes) Spreadsheets API. Here is the full API spec:

Base URL: https://notes.quikdb.com/api/v1
Auth: Bearer token in Authorization header (API key starts with "quikdb_")

ENDPOINTS:
- GET /spreadsheets — List spreadsheets. Query: limit, offset, folderId
- POST /spreadsheets — Create. Body: { title, folderId?, sheets?: ["Sheet1", "Sheet2"] }. Returns { id }
- GET /spreadsheets/:id — Get metadata. Query: ?includeData=true for full cell data
- PUT /spreadsheets/:id — Update title/folder. Body: { title?, folderId? }
- DELETE /spreadsheets/:id — Delete permanently

SHEETS:
- GET /spreadsheets/:id/sheets — List sheets (id, name, rowCount, columnCount)
- POST /spreadsheets/:id/sheets — Add sheet. Body: { name }. Returns { sheetId }

CELLS (use sheet ID from list-sheets):
- GET /spreadsheets/:id/sheets/:sheetId/cells — Read cells. Query: ?range=A1:D10
- PUT /spreadsheets/:id/sheets/:sheetId/cells — Write cells. Body: { range: "A1:C3", values: [[1,2,3],[4,5,6],[7,8,9]], formulas?: [["=SUM(A1:A2)"]] }
- PATCH /spreadsheets/:id/sheets/:sheetId/cells — Update individual cells (Paid). Body: { cells: [{ cell: "A1", value: 42 }] }
- POST /spreadsheets/:id/sheets/:sheetId/append — Append rows (Paid). Body: { values: [[row1...],[row2...]] }
- POST /spreadsheets/:id/sheets/:sheetId/clear — Clear. Body: { range?: "A1:D10" } (omit range to clear all)

EXPORT/IMPORT:
- GET /spreadsheets/:id/export?format=csv&sheet=sheetId — Export as CSV
- GET /spreadsheets/:id/export?format=json — Export as JSON
- POST /spreadsheets/:id/import — Import (Paid). Body: { values: [[...]], sheet: "Sheet1" } or Content-Type: text/csv with raw CSV

Cell references use A1 notation (A1, B2:D10). Rate limits: 30 req/min (free), 100 req/min (paid).

EXAMPLE — Create spreadsheet and write data:
curl -X POST https://notes.quikdb.com/api/v1/spreadsheets \
  -H "Authorization: Bearer quikdb_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Sales Data", "sheets": ["Q1", "Q2"]}'

# Then write cells (use sheetId from GET /spreadsheets/:id/sheets)
curl -X PUT https://notes.quikdb.com/api/v1/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID/cells \
  -H "Authorization: Bearer quikdb_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"range": "A1:C2", "values": [["Product","Price","Qty"],["Widget",9.99,100]]}'

Please write code to [DESCRIBE YOUR TASK HERE]. Use my API key from the environment variable QUIKDB_API_KEY.

Read the full guide

Log in or create a free account to access all 13 sections — including E-Signatures, API Reference, SDKs, and more.