API Surface Reference

Generated page — do not edit by hand

Rendered by scripts/build_reference_pages.py from the committed

537 contract trinity. Run python scripts/build_reference_pages.py build

after changing a source; CI runs check and fails on stale output.

Redoc/OpenAPI 3.1 rendering over the checked-in contract Template Service API v0.1.0 (templates/surface-template/specs/example.openapi.yaml). Sci-lock OS is the reference surface today; additional services join as #565 OpenAPI specs land.

Brand-free example service contract for reusable surface generation.

Operations

Method	Path	operationId	Summary
GET	/items	listItems	List items
POST	/items	createItem	Create item
GET	/items/{item_id}	getItem	Get item

GET /items — listItems

Return a bounded page of item records.

Parameter	In	Required	Type	Description
limit	query	no	integer	Maximum number of items to return.

Status	Description	Schema
200	Page of items.	ItemList

POST /items — createItem

Create one item record.

Request body (application/json): ItemCreate (required).

Status	Description	Schema
201	Created item.	Item

GET /items/{item_id} — getItem

Fetch one item by identifier.

Parameter	In	Required	Type	Description
item_id	path	yes	string	Item identifier.

Status	Description	Schema
200	Item record.	Item

Spec / impl parity

Parity status from references/co-scientist-surface-registry.json (co-scientist surface registry). Every surface below implements the same operation from one contract — the trinity parity guarantee of #537.

Surface	operationId	Parity group	Component
rest	runScienceLoop	run	—
sdk_python	runScienceLoop	run	—
sdk_typescript	runScienceLoop	run	—
cli	runScienceLoop	run	—
mcp	runScienceLoop	run	—
ui_card	streamRunEvents	run	hordago.html_report.run_cockpit