Synopsis
Endpoint identifier
The<endpoint> argument accepts two forms:
If a two-part identifier is ambiguous,
params will list the available actions
and exit with an error.
Options
Examples
Text output
- API Path — the upstream URL the CLI will
POSTto (also useful formulerouter status) - Result Key — the JSON key under which result URLs appear (
videos,images,audios, …) - Available On — which sites expose this endpoint
JSON output
Naming convention
Parameter names in the catalog usesnake_case (matching the JSON request
body), while CLI flags use --kebab-case. The CLI converts between the two
automatically.
See also
mulerouter run— actually invoke the endpointmulerouter list— find an endpoint identifier

