Postman

A Collection v2.1 you can import as a file or a URL. Same routes as this docs site. Import the JSON file, not this HTML page.

Download collection

Import

File. Postman → Import → File → choose the downloaded hookest.postman_collection.json.

URL. Postman desktop → Import → Link → paste one of:

https://api.hookest.com/hookest.postman_collection.json
https://api.hookest.com/postman.json

Local: http://localhost:3000/hookest.postman_collection.json. Postman for Web cannot fetch localhost — use the file or the api.hookest.com URL.

Then open the collection → Variables → set api_key to your hk_live_… key. Leave base_url as https://api.hookest.com.

Do not put the key in the query string. Collection auth is Bearer. A query api_key or key always returns 401.

Variables

Variable	Used by
`api_key`	Every `/v1/*` request (Bearer)
`base_url`	Host
`hook_id`	Get a hook
`upload_url`	Upload the clip (filled by Get upload link)
`upload_id`	Retry start only
`prediction_id`	Get prediction (filled by Get upload link)
`webhook_url`	Set webhook

Predict is three requests in the Score a clip folder. First Get upload link — Send, no file. The collection saves upload_url, upload_id, and prediction_id. Then Upload the clip — Body → binary → Select File → pick the .mp4 → Send. Auth is off on that request. Then Get prediction. If status stays awaiting_upload after a 2xx upload, run Retry start (outside the folder).

Prefer the collection over /openapi.json. The collection already has auth, folders, and example bodies.