Expand description
The Layover HTTP surface, generated from api/openapi.yaml.
@generated by cargo xtask generate-api. Do not edit by hand: cargo xtask verify
regenerates this file and fails if the result differs, so an edit here is reverted
rather than kept. Change the specification instead.
Source: Layover Tower API v0.22.0
Structs§
- Agent
- One configured agent.
- Agent
List - The factory’s agents and the edges between them.
- Cancel
Flight Path - path parameters for
cancelFlight. - Cost
Bucket - One named slice of spend, such as an agent or a model.
- Cost
Report - Where the factory’s money went.
- Cost
Summary - Totals over some set of runs, carrying their own confidence.
- Flag
- A boolean parameter a pipeline accepts at trigger time.
- Flag
Value - A flag resolved to the value one run will see. Distinct from
Flag, which declares what a pipeline accepts: a declaration carries a default, and reporting that default back as though it were the operator’s choice would hide the difference between a flag left alone and a flag deliberately set to the same value. - Flight
Accepted - Confirmation that work has been started.
- GetCosts
Query - query parameters for
getCosts. - GetGraph
Query - query parameters for
getGraph. - GetReport
Path - path parameters for
getReport. - GetRun
Path - path parameters for
getRun. - Ground
Stop - Whether everything is halted.
- Health
- Whether the Tower is up and whether it is allowed to do anything.
- Help
List - Matching help requests, most recent first.
- Help
Request - One agent asking a human for something.
- Help
Resolved - The result of resolving.
- Itinerary
- One causal chain of flights, and the budget it shares.
- Itinerary
List - Chains of work.
- Judge
Learning Path - path parameters for
judgeLearning. - Judge
Learning Request - A person’s verdict on a learning.
- Learning
- Something an agent worked out, with its history.
- Learning
List - Matching learnings.
- List
Help Query - query parameters for
listHelp. - List
Itineraries Query - query parameters for
listItineraries. - List
Learnings Query - query parameters for
listLearnings. - List
Runs Query - query parameters for
listRuns. - Pending
Flight - A flight that has been asked for and not yet dispatched.
- Pending
List - Work waiting to start.
- Pipeline
- A named entry point into the mesh.
- Pipeline
List - Every declared pipeline.
- Problem
- An error, shaped after RFC 9457.
- Report
- What an agent wrote about its own run.
- Reserve
State - The factory-wide spend ceiling. Distinct from Fuel, which bounds one itinerary: a scheduled pipeline mints a fresh itinerary with a fresh Fuel budget on every tick, so only the Reserve bounds the total. The window rolls rather than resetting at midnight.
- Resolve
Help Request - Which open help requests to mark as dealt with.
- Route
- One entry of the route map, possibly expanding to several edges.
- Route
Map - The factory drawn as a graph.
- Run
- One supervised CLI execution.
- RunList
- Matching runs, newest first.
- Send
Flight Request - Exactly one of
pipelineandtomust be given, and flags are only accepted alongside a pipeline, because a pipeline is what declares them. - Stream
RunPath - path parameters for
streamRun. - Token
Usage - Tokens consumed. Cached reads and writes are counted apart from fresh input because providers price them very differently, and blending them makes any derived cost wrong by whatever the cache hit rate happened to be.
- Trigger
- What starts a pipeline.
- Window
Span - A resolved window, and an honest account of how it was arrived at.
Enums§
- Access
- Whether an agent writes to the shared workspace or gets a snapshot.
- Blocker
- What kind of thing an agent is stuck on. Coarse on purpose: the point is to make “half my runs are stuck on credentials” visible at a glance, with the detail in the prose.
- Cost
Source - Where a cost figure came from, worst-first.
reportedis the only kind worth billing against;rate_cardwas derived from token counts and published prices;unreportedmeans the runner said nothing, so the figure is zero and means nothing. - Cost
Window - A period to report over.
- Impact
- How much applying a learning would change a future run. Self-assessed, and therefore used for display and triage only — never to decide whether a learning applies.
- Itinerary
State - What became of a chain.
- Join
- The condition under which a rendezvous barrier releases.
- Judgement
- What a person decided about a learning that is already in use.
- Learning
State - Where a learning is in its life.
provisionalapplies now and will lapse unless rediscovered;confirmedhas been rediscovered enough times to be treated as real;lapsedis remembered only so a later rediscovery can be recognised as one;rejectedwas refused by a human and never counts again. - RunStatus
- How a run ended, or that it has not.
- Status
- Liveness of the Tower itself.
- Trigger
Kind - Whether a human or a clock starts a pipeline.
- Workspace
- Whether instances of one pipeline share a working directory or get one each. A schedule fires whether or not the last instance finished, so anything reaching a read-write agent wants its own.
Constants§
- OPERATIONS
- Every operation the specification declares, as (method, path, operationId).
Traits§
- Api
- Everything the Tower must implement to serve this API.
Functions§
- router
- Builds the axum router for this API.