Instant API

Call Instant from your code.

API plans include key management, monthly quota, searchable access to the live tool catalog, and authenticated server endpoints at https://api.instant.tw.

Authentication

Send your key as a bearer token or as x-api-key. Keys are shown once and stored only as hashes. Use keys from server-side code whenever possible; browser calls are CORS-enabled, but any key embedded in public frontend code can be copied by visitors.

curl https://api.instant.tw/v1/health \
  -H "Authorization: Bearer sk_live_inst_..."

Slugify Text

curl https://api.instant.tw/v1/text/slugify \
  -H "Authorization: Bearer sk_live_inst_..." \
  -H "Content-Type: application/json" \
  -d '{"text":"A Better PDF Tool", "maxLength":80}'

Base64

curl https://api.instant.tw/v1/text/base64 \
  -H "Authorization: Bearer sk_live_inst_..." \
  -H "Content-Type: application/json" \
  -d '{"mode":"encode", "text":"hello"}'

Hash

curl https://api.instant.tw/v1/hash \
  -H "Authorization: Bearer sk_live_inst_..." \
  -H "Content-Type: application/json" \
  -d '{"algorithm":"sha256", "text":"hello"}'

Tool Catalog

Search all live tools, filter the 292 freemium tools, and return launch URLs for browser-hosted utilities.

curl "https://api.instant.tw/v1/catalog?q=pdf&pricing=freemium&limit=25" \
  -H "Authorization: Bearer sk_live_inst_..."

Server PDF Tools

Run backend-backed PDF and Office conversions. Use /v1/server-tools for accepted file types and aliases.

curl https://api.instant.tw/v1/run/pdf-to-word \
  -H "Authorization: Bearer sk_live_inst_..." \
  -F "file=@document.pdf" \
  -o document.docx

eSign API

Create PDF signature requests and list status from code. Signer links remain token-gated.

curl https://api.instant.tw/v1/sign/request \
  -H "Authorization: Bearer sk_live_inst_..." \
  -F "file=@contract.pdf" \
  -F 'recipients=[{"email":"signer@example.com","name":"Signer"}]'

Limits

PlanIncluded callsRate limit
API Starter10,000 / month60 / minute
API Scale100,000 / month300 / minute

Usage is counted in Firestore per UTC month. Calls above the included quota are tracked as overage and billed as Stripe invoice items before the next invoice, with a hard ceiling at 5× included calls to stop runaway usage.