Skip to content

Commit 9904744

Browse files
committed
Document Agent Challenge frontend API
1 parent 00b8e20 commit 9904744

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

docs/miner/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,32 @@ GET /challenges/{challenge_slug}/...
3333
The exact path after the challenge slug belongs to the challenge repository. Platform does not define
3434
the artifact format, task rules, scoring rubric, or leaderboard fields for each challenge.
3535

36+
37+
## Agent Challenge Frontend API
38+
39+
Frontend reads for Agent Challenge should use the Platform master/proxy base:
40+
41+
```http
42+
GET /v1/registry
43+
GET /challenges/agent-challenge/benchmarks
44+
GET /challenges/agent-challenge/submissions/{id}/status
45+
GET /challenges/agent-challenge/submissions/{id}/events
46+
GET /challenges/agent-challenge/leaderboard
47+
```
48+
49+
Uploads have two public paths:
50+
51+
```http
52+
POST /v1/challenges/agent-challenge/submissions
53+
POST /challenges/agent-challenge/submissions
54+
```
55+
56+
Use `POST /v1/challenges/agent-challenge/submissions` for raw ZIP bridge uploads. Platform verifies the miner upload and forwards it to Agent Challenge. Use `POST /challenges/agent-challenge/submissions` for the JSON base64 generic proxy path when the client signs the challenge-local `/submissions` request.
57+
58+
For v1 lists, `/challenges/agent-challenge/submissions` returns the latest 100 submissions newest-first. `/challenges/agent-challenge/leaderboard` returns one best scoring row per hotkey. Pagination, filtering, and client-selected sorting are deferred to future v2.
59+
60+
The public proxy blocks `/internal/*`, `/health`, and `/version`.
61+
3662
## What Platform Does For Miners
3763

3864
Platform provides:

0 commit comments

Comments
 (0)