Skip to main content

Bounty read API

The current Rust API provides read-only access to bounty-engine proposal and evaluation state. It is useful for operations dashboards and services that need a bounded HTTP interface instead of reading engine state files directly.

List proposals

The implementation defaults limit to 25, clamps it between 1 and 100, and defaults offset to 0. For a local process using the default bind:
Use the deployed gateway URL when the service sits behind a reverse proxy or authenticated edge.

List evaluations

The same pagination bounds apply.

Health

The health handler attempts to read configured bounty state, so it checks more than whether the HTTP server is accepting connections. If state is unavailable, the service returns 503 with:
A load balancer or process monitor should treat that as unhealthy.

Client pagination

A client can advance offset until a returned page contains fewer records than the requested limit. Adapt the exact collection field to the response type in the deployed bounty_api model.

Read-only means read-only

The router explicitly rejects unsupported mutation methods. Do not build an administration client around an undocumented POST request. Bounty creation, claim, approval and settlement belong to their authorized engine and protocol paths.

Operations use case

An internal dashboard can read evaluations, group them by trigger class, show proposals awaiting funding and link each record back to the relevant Capsule. It can remain read-only while higher-risk mutations stay behind separate authority. That boundary reduces the blast radius of a public or broadly accessible monitoring interface.