ORorcarouter
Tools

Run a tool

Changed on

Execute a tool and return its output with what it cost. The run is quoted on the most units its input allows, held against the workspace wallet, the key's quota and any budget, then settled to the units delivered — never more than 1.25 × the quote. Synchronous. Limited to 60 runs per minute per key. See Run a tool and Errors.

post/tools/{id}/run

Request

  • Base URL
    https://api.orcarouter.ai/v1
  • URL
    https://api.orcarouter.ai/v1/tools/{id}/run
  • Auth
    HTTP bearer

Path parameters

idstring required

A tool id from discover.

Headers

X-Orca-Run-Refstring

Count the run against an existing run budget with this reference. An unknown reference is refused with 400 bad_input.

X-OrcaRouter-Firewall-Approvalstring

On the retry of a run the Agent Firewall held, the firewall_approval_id a human approved. Comma-separate up to 8.

Request body

inputobject required

Validated against the tool's input_schema.

approval_idinteger

On the retry of a run a spend policy sent for approval.

wait_msinteger

Accepted and ignored. Runs are synchronous.

Response

The run completed.

successboolean

Changes