Overview
Understand the FileMorf public API model: API keys, direct uploads, queued jobs, retained artifacts, and background recipes.
https://api.filemorf.com/api/public
Bearer API key created from the workspace.
Signed uploads, queued jobs, retained artifacts, refreshable URLs.
Model
One API, two execution patterns
The public API exposes direct jobs for single operations and background recipes for retained-file automation. Both models share the same upload, queue, and artifact lifecycle.
Direct jobs
Create a job, upload the input directly to the returned signed URL, start the job, then poll for status or consume webhook events.
Background recipes
Run ordered server-side workflow steps against retained artifacts, including prior multi-file outputs.
/
Inspect the public API surface and current endpoint map.
/jobs
Create a single-input job and receive one upload URL.
/merge
Create a multi-file PDF merge job and receive one upload URL per input.
/jobs
List API-created jobs for the authenticated key owner.
/jobs/:id
Fetch job status, result metadata, and download URLs.
/jobs/:id/start
Queue a pending job after upload completes.
/jobs/:id/refresh-url
Refresh signed output URLs for completed jobs.
/recipes
List saved workflow recipes.
/recipes
Create a background workflow recipe through the public API.
/recipes/:id/runs
Run a saved recipe against a retained artifact or prior job output.
/recipe-runs/:id
Poll a workflow run and inspect step-level execution state.
Base URLs
Use the same contract in production and local development
Production traffic goes through the FileMorf API host. Local development uses the backend container or dev server directly.
| Environment | Base URL | Notes |
|---|---|---|
| Production | https://api.filemorf.com/api/public | Public API host for deployed integrations. |
| Local | http://localhost:3001/api/public | Default backend route when running locally. |
Capabilities
What the public API supports today
The current surface is broad enough to support external ingestion, conversion, merge workflows, retained output automation, and signed delivery monitoring.
- Single-input jobs for image, PDF, document, spreadsheet, structured-data, and OCR processing.
- Multi-file PDF merge through a dedicated endpoint with one signed upload URL per source file.
- Refreshable signed download URLs for completed results and multi-output job files.
- Recipe listing, creation, and execution against retained artifacts or prior job outputs.
- Signed webhook delivery for job lifecycle events created from the FileMorf workspace.