Thanks for taking the time. This repo is the public documentation and examples for the Onsight API — the service itself lives at onsight.photo. Contributions here are about making the API easier to use.
- Docs that are wrong or unclear — an endpoint, header, or payment step that doesn't match what the API actually does. Include the request you sent and the response you got (redact wallet keys and signatures).
- Broken examples — if
examples/doesn't run, tell us your Node version, the command you ran, and the full error. - API bugs — unexpected status codes, wrong prices in a
402, settlement or payout problems. Include the mission id and, if payment-related, the on-chaintxHash(public info, safe to share). - Questions about integrating — how to call it from your agent framework, language, or wallet setup. No such thing as a dumb one.
Open an issue titled [feature] ... and cover:
- The job to be done — what your agent or app is trying to accomplish.
- Why the current API can't — the missing endpoint, field, filter, or payment mode.
- A sketch of the shape — the request/response you'd want, if you have one in mind.
Concrete use cases move fastest. "My agent needs to filter open missions by radius" beats "please add filtering".
For docs and examples in this repo, PRs are welcome:
- Fork and branch.
- Keep changes focused — one fix or example per PR.
- If you touch
examples/, make sure it still runs (cd examples && npm install && node <file>). - Open the PR with a short description of what and why.
Found a vulnerability — in the payment flow, escrow, or wallet-signature auth? Don't open a public issue. See SECURITY.md.
Be decent. Assume good faith, keep it about the work, and help newcomers.