|
Download docs/API.md from tmepass000/matter-os: direct link, hf CLI and curl.
- Browser
- Download file 3.2 kB
-
https://huggingface.co/tmepass000/matter-os/resolve/main/docs/API.md
- Command line
-
hf download hf://tmepass000/matter-os/docs/API.md
-
curl -L -o API.md https://huggingface.co/tmepass000/matter-os/resolve/main/docs/API.md
3.2 kB
| # API (v1) - section 14 mapping | |
| Base path `/api/v1`. Typed request models are in `apps/api.py`; the OpenAPI schema is served at `/docs` and `/openapi.json`. | |
| Errors are returned as `{"error": <ErrorCode>, "message", "details"}` with HTTP 400/409/422/429/503/504. | |
| | API | Operation | Endpoint | | |
| |---|---|---| | |
| | Project | create_project | `POST /projects` | | |
| | | update_goal | `PUT /projects/{id}/goal` | | |
| | | set_constraints | `PUT /projects/{id}/constraints` | | |
| | | archive_project | `POST /projects/{id}/archive?confirm=true` | | |
| | Mission | create_mission | `POST /missions` | | |
| | | plan_tasks | `POST /missions/{id}/plan` | | |
| | | pause / resume / cancel / branch | `POST /missions/{id}/pause`, `/resume`, `/cancel?confirm=true`, `/branch` | | |
| | | (controls) run, approve, reject, change budget | `/run`, `/approve`, `/reject`, `/budget` | | |
| | Candidate | generate | `POST /candidates/generate` | | |
| | | transform | `POST /candidates/{id}/transform` | | |
| | | validate_schema | `POST /candidates/validate_schema` | | |
| | | compare | `GET /candidates/compare?a=&b=` | | |
| | | export | `GET /candidates/{id}/export?fmt=xyz|cif|sdf` | | |
| | Simulation | list_compatible_solvers | `GET /simulation/compatible?candidate_id=&observable=` | | |
| | | estimate_cost | `GET /simulation/estimate` | | |
| | | submit_run | `POST /simulation/runs` | | |
| | | get_status | `GET /simulation/jobs/{job_id}` | | |
| | | fetch_artifacts | `GET /simulation/runs/{run_id}/artifacts`, `GET /artifacts/{id}` | | |
| | Agent | assign_task | `POST /agents/assign_task?role=&mission_id=&stage=` | | |
| | | send_message | `POST /agents/messages` | | |
| | | publish_result | `POST /agents/publish_result` | | |
| | | request_review | `POST /agents/request_review` | | |
| | Evidence | compute_maturity | `POST /evidence/{candidate_id}/maturity` | | |
| | | attach_claim | `POST /evidence/{candidate_id}/claims` | | |
| | | request_replication | `POST /evidence/{candidate_id}/replication?run_id=` | | |
| | | compare_sources | `POST /evidence/compare_sources` | | |
| | Knowledge | propose_event | `POST /knowledge/events` | | |
| | | verify_event | `POST /knowledge/events/{fact_id}/verify` | | |
| | | search_graph | `GET /knowledge/search` | | |
| | | get_lineage | `GET /knowledge/lineage/{candidate_id}` | | |
| | Resource | get_capacity | `GET /resources/capacity` | | |
| | | allocate | `POST /resources/allocate` (+ `/release`) | | |
| | | checkpoint | `POST /resources/checkpoint/{job_or_mission_id}` | | |
| | | enforce_quota | `POST /resources/enforce_quota` | | |
| | Export | export_structure | `GET /export/structure/{candidate_id}` | | |
| | | export_run_bundle | `GET /export/run/{run_id}` | | |
| | | export_report | `GET /export/report/{mission_id}?fmt=md|json` | | |
| | | export_project | `GET /export/project/{project_id}` | | |
| Extras: `/simulation/solvers`, `/simulation/plan`, `/agents` (roster), `/agents/evaluations`, `/agents/benchmarks`, | |
| `/agents/improvements/{id}/deploy|rollback`, `/evidence/benchmarks`, `/knowledge/status_counts`, `/knowledge/sources`, | |
| `/resources/snapshot`, `/resources/integrity`, `/resources/queue`, `/control/pause_all`, `/observability/audit|metrics|failures`, | |
| `/viewer/{candidate_id}`, `/dashboard/summary`. | |
| Schema versions: data contracts `1.0.0` (`core/schemas.SCHEMA_VERSION`); DB migrations `0001_initial`, `0002_immutability_triggers`. | |