/
GA
gastownhall
/
Gas City Supervisor API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
1
Docs
History
Schema
Filter operations
get
/health
Get health
get
/v0/cities
Get v0 cities
post
/v0/city
Post v0 city
get
/v0/city/{cityName}
Get v0 city by city name
patch
/v0/city/{cityName}
Patch v0 city by city name
get
/v0/city/{cityName}/agent/{base}
Get v0 city by city name agent by base
delete
/v0/city/{cityName}/agent/{base}
Delete v0 city by city name agent by base
patch
/v0/city/{cityName}/agent/{base}
Patch v0 city by city name agent by base
get
/v0/city/{cityName}/agent/{base}/output
Get v0 city by city name agent by base output
get
/v0/city/{cityName}/agent/{base}/output/stream
Stream agent output in real time
post
/v0/city/{cityName}/agent/{base}/{action}
Post v0 city by city name agent by base by action
get
/v0/city/{cityName}/agent/{dir}/{base}
Get v0 city by city name agent by dir by base
delete
/v0/city/{cityName}/agent/{dir}/{base}
Delete v0 city by city name agent by dir by base
patch
/v0/city/{cityName}/agent/{dir}/{base}
Patch v0 city by city name agent by dir by base
get
/v0/city/{cityName}/agent/{dir}/{base}/output
Get v0 city by city name agent by dir by base output
get
/v0/city/{cityName}/agent/{dir}/{base}/output/stream
Stream agent output in real time (qualified name)
post
/v0/city/{cityName}/agent/{dir}/{base}/{action}
Post v0 city by city name agent by dir by base by action
get
/v0/city/{cityName}/agents
Get v0 city by city name agents
post
/v0/city/{cityName}/agents
Create an agent
get
/v0/city/{cityName}/bead/{id}
Get v0 city by city name bead by ID
delete
/v0/city/{cityName}/bead/{id}
Delete v0 city by city name bead by ID
patch
/v0/city/{cityName}/bead/{id}
Patch v0 city by city name bead by ID
post
/v0/city/{cityName}/bead/{id}/assign
Post v0 city by city name bead by ID assign
post
/v0/city/{cityName}/bead/{id}/close
Post v0 city by city name bead by ID close
get
/v0/city/{cityName}/bead/{id}/deps
Get v0 city by city name bead by ID deps
post
/v0/city/{cityName}/bead/{id}/reopen
Post v0 city by city name bead by ID reopen
post
/v0/city/{cityName}/bead/{id}/update
Post v0 city by city name bead by ID update
get
/v0/city/{cityName}/beads
Get v0 city by city name beads
post
/v0/city/{cityName}/beads
Create a bead
get
/v0/city/{cityName}/beads/graph/{rootID}
Get v0 city by city name beads graph by root ID
get
/v0/city/{cityName}/beads/ready
Get v0 city by city name beads ready
get
/v0/city/{cityName}/config
Get v0 city by city name config
get
/v0/city/{cityName}/config/defaults
Get v0 city by city name config defaults
get
/v0/city/{cityName}/config/explain
Get v0 city by city name config explain
get
/v0/city/{cityName}/config/validate
Get v0 city by city name config validate
get
/v0/city/{cityName}/convoy/{id}
Get v0 city by city name convoy by ID
delete
/v0/city/{cityName}/convoy/{id}
Delete v0 city by city name convoy by ID
post
/v0/city/{cityName}/convoy/{id}/add
Post v0 city by city name convoy by ID add
get
/v0/city/{cityName}/convoy/{id}/check
Get v0 city by city name convoy by ID check
post
/v0/city/{cityName}/convoy/{id}/close
Post v0 city by city name convoy by ID close
post
/v0/city/{cityName}/convoy/{id}/remove
Post v0 city by city name convoy by ID remove
get
/v0/city/{cityName}/convoys
Get v0 city by city name convoys
post
/v0/city/{cityName}/convoys
Create a convoy
get
/v0/city/{cityName}/events
Get v0 city by city name events
post
/v0/city/{cityName}/events
Emit an event
post
/v0/city/{cityName}/events/rotate
Force rotate the city event log
get
/v0/city/{cityName}/events/stream
Stream city events in real time
get
/v0/city/{cityName}/extmsg/adapters
Get v0 city by city name extmsg adapters
post
/v0/city/{cityName}/extmsg/adapters
Register an external messaging adapter
delete
/v0/city/{cityName}/extmsg/adapters
Delete v0 city by city name extmsg adapters
post
/v0/city/{cityName}/extmsg/bind
Post v0 city by city name extmsg bind
get
/v0/city/{cityName}/extmsg/bindings
Get v0 city by city name extmsg bindings
get
/v0/city/{cityName}/extmsg/groups
Get v0 city by city name extmsg groups
post
/v0/city/{cityName}/extmsg/groups
Ensure an external messaging group exists
post
/v0/city/{cityName}/extmsg/inbound
Post v0 city by city name extmsg inbound
post
/v0/city/{cityName}/extmsg/outbound
Post v0 city by city name extmsg outbound
post
/v0/city/{cityName}/extmsg/participants
Post v0 city by city name extmsg participants
delete
/v0/city/{cityName}/extmsg/participants
Delete v0 city by city name extmsg participants
get
/v0/city/{cityName}/extmsg/transcript
Get v0 city by city name extmsg transcript
post
/v0/city/{cityName}/extmsg/transcript/ack
Post v0 city by city name extmsg transcript ack
post
/v0/city/{cityName}/extmsg/unbind
Post v0 city by city name extmsg unbind
get
/v0/city/{cityName}/formula/{name}
Get v0 city by city name formula by name
get
/v0/city/{cityName}/formulas
Get v0 city by city name formulas
get
/v0/city/{cityName}/formulas/feed
Get v0 city by city name formulas feed
get
/v0/city/{cityName}/formulas/{name}
Get v0 city by city name formulas by name
put
/v0/city/{cityName}/formulas/{name}
Put v0 city by city name formulas by name
delete
/v0/city/{cityName}/formulas/{name}
Delete v0 city by city name formulas by name
post
/v0/city/{cityName}/formulas/{name}/preview
Post v0 city by city name formulas by name preview
get
/v0/city/{cityName}/formulas/{name}/runs
Get v0 city by city name formulas by name runs
get
/v0/city/{cityName}/formulas/{name}/source
Get v0 city by city name formulas by name source
post
/v0/city/{cityName}/formulas/{name}/validate
Post v0 city by city name formulas by name validate
get
/v0/city/{cityName}/health
Get v0 city by city name health
get
/v0/city/{cityName}/mail
Get v0 city by city name mail
post
/v0/city/{cityName}/mail
Send a mail message
get
/v0/city/{cityName}/mail/count
Get v0 city by city name mail count
get
/v0/city/{cityName}/mail/thread/{id}
Get v0 city by city name mail thread by ID
get
/v0/city/{cityName}/mail/{id}
Get v0 city by city name mail by ID
delete
/v0/city/{cityName}/mail/{id}
Delete v0 city by city name mail by ID
post
/v0/city/{cityName}/mail/{id}/archive
Post v0 city by city name mail by ID archive
post
/v0/city/{cityName}/mail/{id}/mark-unread
Post v0 city by city name mail by ID mark unread
post
/v0/city/{cityName}/mail/{id}/read
Post v0 city by city name mail by ID read
post
/v0/city/{cityName}/mail/{id}/reply
Reply to a mail message
post
/v0/city/{cityName}/maintenance/dolt-gc
Trigger a Dolt store maintenance run
get
/v0/city/{cityName}/maintenance/status
Get v0 city by city name maintenance status
get
/v0/city/{cityName}/order/history/{bead_id}
Get v0 city by city name order history by bead ID
get
/v0/city/{cityName}/order/{name}
Get v0 city by city name order by name
post
/v0/city/{cityName}/order/{name}/disable
Post v0 city by city name order by name disable
post
/v0/city/{cityName}/order/{name}/enable
Post v0 city by city name order by name enable
post
/v0/city/{cityName}/order/{name}/run
Post v0 city by city name order by name run
get
/v0/city/{cityName}/orders
Get v0 city by city name orders
get
/v0/city/{cityName}/orders/check
Get v0 city by city name orders check
get
/v0/city/{cityName}/orders/feed
Get v0 city by city name orders feed
get
/v0/city/{cityName}/orders/history
Get v0 city by city name orders history
get
/v0/city/{cityName}/packs
Get v0 city by city name packs
post
/v0/city/{cityName}/packs
Add a pack
delete
/v0/city/{cityName}/packs/{name}
Delete v0 city by city name packs by name
get
/v0/city/{cityName}/patches/agent/{base}
Get v0 city by city name patches agent by base
delete
/v0/city/{cityName}/patches/agent/{base}
Delete v0 city by city name patches agent by base
get
/v0/city/{cityName}/patches/agent/{dir}/{base}
Get v0 city by city name patches agent by dir by base
delete
/v0/city/{cityName}/patches/agent/{dir}/{base}
Delete v0 city by city name patches agent by dir by base
get
/v0/city/{cityName}/patches/agents
Get v0 city by city name patches agents
Copy Markdown
Copied
Copy failed
Changes to Create a convoy
post
/v0/city/{cityName}/convoys
Oct 7, 2026
04d6dfe60530
Revision changes
○
added the optional property
close_reason
to the response with the
201
status
Ask about this API