Files Workshop logoFiles Workshop
Developer API

Files Workshop API

Automate the server-side tools — conversions, OCR, video and audio — from your own apps. Authenticate with an API key, start a job, poll for status, download the result. Your plan's daily limits and file-size caps apply.

Your API keys

Quickstart

# 1. Start a job
curl -X POST https://filesworkshop.app/api/v1/word-to-pdf \
  -H "Authorization: Bearer ak_live_xxx" \
  -F "file=@document.docx" \
  -F 'options={}'
# → { "jobId": "abc123", "status": "queued",
#     "statusUrl": ".../api/v1/jobs/abc123",
#     "resultUrl": ".../api/v1/jobs/abc123/result" }

# 2. Poll until completed
curl https://filesworkshop.app/api/v1/jobs/abc123 \
  -H "Authorization: Bearer ak_live_xxx"
# → { "state": "completed" }

# 3. Download the result
curl -L https://filesworkshop.app/api/v1/jobs/abc123/result \
  -H "Authorization: Bearer ak_live_xxx" -o out.pdf

Endpoints

  • POST /api/v1/{tool} — start a job (multipart file + optional JSON options).
  • GET /api/v1/jobs/{jobId} — check status (queued / active / completed / failed).
  • GET /api/v1/jobs/{jobId}/result — download the finished file.

Available tools (51)

Pass the tool id as {tool}. Browser-only tools aren't available via the API.

auto-renameAI Auto-Rename
ai-detectAI Content Detector
mp3-to-textAudio to Text
business-cardBusiness Card to vCard
change-volumeChange Audio Volume
chatChat with PDF
compress-videoCompress Video
contract-reviewContract Review
audio-convertConvert Audio
convert-videoConvert Video
csv-to-pdfCSV to PDF
excel-to-pdfExcel to PDF
action-itemsExtract Action Items
extract-dataExtract Data
extract-frameExtract Video Frame
find-deadlinesFind Dates & Deadlines
grammar-checkGrammar Checker
grammar-studioGrammar Studio
handwriting-ocrHandwriting OCR (AI)
html-to-pdfHTML to PDF
key-pointsKey Points
meeting-minutesMeeting Minutes
mute-videoMute Video
ocrOCR PDF
odp-to-pdfODP to PDF
ods-to-pdfODS to PDF
odt-to-pdfODT to PDF
paraphraseParaphrase / Reword
pdf-to-excelPDF to Excel
pdf-to-pdfaPDF to PDF/A
pdf-to-powerpointPDF to PowerPoint
pdf-to-wordPDF to Word
plagiarismPlagiarism Checker
powerpoint-to-pdfPowerPoint to PDF
proofreadProofread PDF
protectProtect PDF
quizQuiz Generator
receipt-extractReceipt to CSV
resume-feedbackResume Feedback
rtf-to-pdfRTF to PDF
simplifySimplify / Explain
study-notesStudy Notes
summarizeSummarize PDF
txt-to-pdfText to PDF
translateTranslate PDF
trim-audioTrim Audio
trim-videoTrim Video
unlockUnlock PDF
video-to-gifVideo to GIF
video-to-mp3Video to MP3
word-to-pdfWord to PDF