Skip to content

API Reference

Capsule keeps the HTTP surface small on purpose. The core API is enough to upload, inspect, download, and delete temporary files without introducing accounts or sessions.

For clarity: the public hosted web client lives at https://withcapsule.dev. The hosted API used by direct integrations and examples lives at https://send.withcapsule.dev.

Uploads a file using multipart form data.

  • form field: f
  • success response: plain text containing the generated file ID

Example:

Terminal window
curl -F "f=@myfile.txt" "https://send.withcapsule.dev/curlup"

Streams the file back with its original filename.

Relevant response headers:

  • Content-Disposition
  • Content-Length
  • X-Encrypted

Returns metadata for a file without downloading it.

{
"file_name": "myfile.txt",
"file_size": 1234,
"upload_time": 1710000000,
"time_remaining": 3540,
"is_encrypted": false
}

Deletes a file immediately and removes its database record.

Simple health check that returns a JSON pong response.

Returns a minimal built-in HTML menu with links to the server’s simple upload and download forms.

Highly applicable for LAN usage.