Skip to main content
POST
/
v1beta2
/
tool
/
start-run
Start Tool Run
curl --request POST \
  --url https://api.hunch.tools/v1beta2/tool/start-run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tool_uid": "4p2QJ",
  "inputs": [
    {
      "title": "Name",
      "text": "Bob"
    }
  ]
}'
{
  "tool_run_uid": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null

Body

application/json

The request body used to start a tool run.

tool_uid
string
required

The unique identifier of the tool to run

inputs
ToolRunInput · object[]
required

The inputs to the tool

Response

Successful Response

The response body returned after starting a tool run.

tool_run_uid
string
required

The unique identifier of the tool run