DocsAI & agents
Using QuickSnip from an agent or script
1 min read
Overview
quicksnip is the command-line client for QuickSnip — install it, upload a video or screenshot from a script or agent, and read the result back as a machine-readable manifest.
Install
npx quicksnip login
Upload
npx quicksnip upload ./bug-repro.mp4 --json
{ "schema": 1, "id": "q09...", "type": "video", "status": "processing", "urls": { "share": "https://quicksnip.com/s/q09...", "agent": "https://quicksnip.com/s/q09....json", "direct": null }, "readiness": { "state": "preparing", "retryAfterSeconds": 5, "instruction": "Still processing. Fetch urls.agent again in about 5s, or re-run with --wait." } }
Read it back
urls.agent is a plain URL — no authentication needed for a world-public recording:
curl https://quicksnip.com/s/q09....json | jq '.readiness, .transcript.text'
Or block until it's ready in one command: quicksnip upload ./bug-repro.mp4 --wait --json.
The full contract
quicksnip guide --json
prints every command, flag, and exit code the installed CLI actually supports — read that instead of hard-coding assumptions from this page, which can go stale.
Can't Find What You Need?
Reach out to our support team and we'll get back to you within 24 hours.