# OkFile

> Agent-first file upload, static site hosting, and video streaming. Three things: (1) upload a file, get a public direct link; (2) publish an ENTIRE FOLDER as a website — each site gets its own subdomain like https://abc123.ok26.org/, nested paths preserved, root index.html rendered as the homepage (auto directory listing without one); (3) turn a VIDEO into STREAMING MEDIA — hosted Cloudflare Stream transcoding returns HLS/DASH playback URLs plus a shareable web player page at /s/{uid}, no Cloudflare account needed. Anonymous: up to 1GB per file, 24-hour retention; API key: up to 1TB.

Static site hosting facts:
- one command publishes a whole folder: `okfile publish ./my-site/` -> prints the site URL
- up to 300 files and 1GB total per site; subdirectories like /docs/guide/ and /assets/app.css work as-is
- a single wrapper folder is stripped automatically (my-site/index.html becomes /index.html)
- no root index.html? visitors get an automatic browsable directory listing — do not generate a fake one

Fastest path (CLI, preferred):
- `pip install okfile` (or `curl -fsSL https://www.okfile.com/install.sh | sh`, PowerShell: `iwr -useb https://www.okfile.com/install.ps1 | iex`)
- `okfile upload <file>` prints the public URL; `okfile publish <dir>` prints the site URL; `okfile upload <video> --stream` prints HLS/DASH playback URLs
- the CLI handles quick vs multipart selection, retries, resume, and progress automatically
- plain-text quickstart: https://www.okfile.com/cli

Raw HTTP (when you cannot install packages):
- Base URL: https://www.okfile.com — endpoint directory at GET /api
- Auth: optional `X-API-Key: okf_...` header (anonymous works for files up to 1GB)
- Small files (<=5MB): single request `POST /api/upload/quick` with multipart/form-data field `file`
- Larger files: `POST /api/upload/prepare` -> `PUT` to presigned URL(s) -> `POST /api/upload/complete`
- Static sites: `POST /api/site/prepare` -> upload each file -> `POST /api/site/complete`
- Discover live limits first: `GET /api/upload/config`
- Lifecycle controls on any upload: `maxDownloads`, `expiresAt` (ISO 8601), `burnAfterRead`
- Video transcoding to HLS/DASH: `okfile upload video.mp4 --stream` or `POST /api/stream/prepare` (hosted Cloudflare Stream; check `streamHosted.supported` in GET /api/upload/config)
- Errors are JSON `{"error": "message"}`; 429 means anonymous rate limit (80 prepares / 10 min / IP)

## Docs

- [Agent skill and full API reference](https://www.okfile.com/SKILL.md): endpoints, request/response examples, error table, Python and Node client examples
- [CLI quickstart (plain text)](https://www.okfile.com/cli): install and common commands
- [API endpoint directory (JSON)](https://www.okfile.com/api): machine-readable endpoint list
- [Homepage](https://www.okfile.com/en/): human-facing overview
- [PyPI package](https://pypi.org/project/okfile/): Python CLI

## Quick examples

okfile upload photo.jpg
curl -X POST "https://www.okfile.com/api/upload/quick" -F "file=@photo.jpg"
both return/print: {"success":true,"id":"...","url":"https://.../i/...","downloadUrl":"...","playUrl":"..."}