Endpoints

toolplexer run

Execute one inspected capability endpoint.

Run an endpoint after inspecting its schema and price. Execution is billed.

Usage

toolplexer run -p <provider> -e <endpoint> -i <input> \
  [--wait [timeout]] [-o <file>] [--json]

Flags

FlagTypeDescription
-p, --provider <provider>stringProvider slug
-e, --endpoint <endpoint>stringEndpoint path
-i, --input <input>JSONInline JSON, @path/to/file.json, or - for stdin
-f, --input-file <path>fileRead JSON from a file; alternative to -i @file
-w, --wait [timeout]numberWait for completion; timeout in seconds, default 300
--timeout <seconds>numberPolling deadline used with --wait (1–3600)
-o, --output <file>fileSave the complete response without overwriting
-j, --jsonbooleanPrint raw JSON

The CLI performs a free inspection and required-field check before placing the paid request. Current adapters accept JSON body input; unsupported nonempty --query and --path objects are rejected explicitly.

Examples

Start a run and poll separately:

toolplexer run -p mock -e /web-search \
  -i '{"query":"cats","maxResults":10}'
toolplexer runs get -r <run-id> -o results.json

Wait for completion:

toolplexer run -p mock -e /web-search \
  -i '{"query":"cats","maxResults":10}' --wait -o results.json

Read complex input from a file:

toolplexer run -p mock -e /web-search -i @params.json

Use execute when ToolPlexer should select the best-value configured provider instead of selecting a provider yourself.

On this page