Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

REST API

The rudra-server provides a REST API for document management.

Base URL

http://localhost:8080/api/v1/

Endpoints

Documents

MethodEndpointDescription
POST/documentsUpload a document (multipart)
GET/documentsList documents (paginated)
GET/documents/:idGet document metadata
GET/documents/:id/contentDownload document bytes
DELETE/documents/:idDelete a document
GET/documents/:id/thumbnailGet PDF thumbnail

Conversion

MethodEndpointDescription
POST/convertStateless format conversion

Webhooks

MethodEndpointDescription
POST/webhooksRegister a webhook
GET/webhooksList webhooks
DELETE/webhooks/:idDelete a webhook

System

MethodEndpointDescription
GET/healthHealth check
GET/infoServer info

Example: Upload and Convert

# Upload a DOCX
curl -X POST http://localhost:8080/api/v1/documents \
  -F file=@report.docx

# Convert to PDF
curl -X POST http://localhost:8080/api/v1/convert \
  -F file=@report.docx \
  -F format=pdf \
  -o report.pdf