/api/routes endpoints using your Bearer API key. Changes take effect immediately — no redeployment required.
POST /api/routes
Creates a new payment route under your organisation.Request body
The route path segment appended after your org slug, e.g.
weather/forecast. Must be unique within your organisation.The per-request price in USD charged to the caller, e.g.
0.01. Settled as USDC on-chain.The full upstream URL that the gateway proxies paid requests to, e.g.
https://api.example.com/forecast.The blockchain network used for settlement. Accepted values:
base, base-sepolia.Whether the route accepts requests. Defaults to
true. Set to false to pause the route without deleting it.Whether the gateway streams the upstream response body. Defaults to
false. Enable for SSE or chunked-transfer upstreams.Whether the route appears in your public route listing. Defaults to
false.A human-readable description shown in the dashboard and MCP manifest.
Example request
Response 201 Created
Unique identifier for the route, e.g.
route_01hx9z2k3m4n5p6q.The organisation this route belongs to.
The route path as stored.
Per-request price in USD.
The upstream URL this route proxies to.
Blockchain network used for settlement.
Whether the route is currently accepting requests.
Whether response streaming is enabled.
Whether the route appears in the public listing.
GET /api/routes
Returns all routes belonging to your organisation.Example request
Response 200 OK
PATCH /api/routes/:id
Updates one or more fields on an existing route. Only fields you include in the request body are changed.Path parameters
The route ID returned when the route was created, e.g.
route_01hx9z2k3m4n5p6q.Request body (all fields optional)
New route path segment. Must remain unique within your organisation.
Updated per-request price in USD.
Updated upstream URL.
Updated settlement network. Accepted values:
base, base-sepolia.Pass
false to pause the route or true to resume it.Enable or disable response streaming.
Show or hide the route in the public listing.
Updated human-readable description.
Example request
Response 200 OK
Returns the full updated route object in the same shape as the POST response.
DELETE /api/routes/:id
Permanently deletes a route. Agents calling the deleted route URL will receive a404 ROUTE_NOT_FOUND error immediately after deletion.
Path parameters
The ID of the route to delete.
Example request
Response 204 No Content
A successful deletion returns 204 with an empty body.