OpenFileConverter Edge WASM Studio
Screen #32 of 60 Batch 6 desktop • 1440x900px

Desktop Developer Hub `/docs/api/` — Fold 2: REST Endpoints Reference & Multipart Uploads

Open Route
Specification & Codex Reference Prompt (Click to expand) (Developer documentation Fold 2: Comprehensive reference table for `POST /v1/convert`, parameters, multipart specifications, and webhook signatures.)

Screen Role: Developer documentation Fold 2: Comprehensive reference table for `POST /v1/convert`, parameters, multipart specifications, and webhook signatures.

Design Intent: A technical API reference UI mockup at 1440x900 resolution in clean Light Mode (Developer Hub Fold 2 of 3, connects below Fold 1). Pure white canvas (#FFFFFF) with 3-column layout. Main content section: "Endpoint: POST /v1/convert". Parameters table with columns "Field", "Type", "Required", "Description": - `file`: binary (required) — The source file to convert (up to 2GB on Pro). - `target_format`: string (required) — Target format identifier (e.g. `pdf`, `webp`, `mp3`, `stl`). - `webhook_url`: string (optional) — HTTPS URL for asynchronous completion postback. - `options`: json (optional) — Format-specific encoding options (e.g. `quality: 90`, `lossless: true`). Right panel: Example JSON response payload (HTTP 200 OK): `{"id": "job_4920", "status": "completed", "output_url": "...", "duration_ms": 28}` Crisp technical typography, clean vector copy icons, zero emojis.

Component Architecture: Django Cotton components (<c-file_converter.* />) with Tailwind tokens matching Labb.io design language.

Direct route: /file-converter/docs/api/#endpoints Template: file_converter/screens/screen_32.html
Live Django Implementation (desktop)
Isolate →
POST /v1/convert

Endpoint: POST /v1/convert

Convert files synchronously or asynchronously via multipart/form-data upload.

Request Parameters (Multipart Form-Data)

Field Type Required Description
file binary required The source file to convert (up to 2GB on Pro tier).
target_format string required Target format identifier (e.g. pdf, webp, mp3, stl).
webhook_url string optional HTTPS URL for asynchronous completion postback with HMAC verification.
options json optional Format-specific encoding options (e.g. {"quality": 90, "lossless": true}).
Response • 200 OK
{
  "id": "job_4920",
  "status": "completed",
  "target_format": "webp",
  "output_url": "https://api.openfileconverter.com/v1/download/job_4920.webp",
  "duration_ms": 28,
  "engine": "rust-wasm-simd",
  "bytes_processed": 1248010,
  "savings_percentage": 78.4
}
Original Codex Reference Mockup Full PNG
Authoritative Reference for Screen #32