Execute an API tool

POST

tools

{tool_id}

execute

Execute an API tool

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/tools/{tool_id}/execute \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "input": {},
  "metadata": {}
}
'

{
  "status_code": 123,
  "headers": {},
  "body": "<unknown>",
  "success": true,
  "error": "<string>",
  "execution_time_ms": 123,
  "request_url": "<string>",
  "request_method": "<string>"
}

Authorizations

x-api-key

string

header

required

Path Parameters

tool_id

string<uuid>

required

Body

application/json

input

Input · object

metadata

Metadata · object

Response

Successful Response

status_code

integer

required

headers

Headers · object

Show child attributes

body

any

success

boolean

default:true

error

string | null

execution_time_ms

number | null

request_url

string | null

request_method

string | null

Preview a revision's RAW response + narrowed field map (no persist)Run a revision's HTTP config and return the RAW body + a narrowed preview. Powers the dashboard field-map editor (ENG-631). Unlike ``/execute`` (which runs the active revision and narrows by its saved map), this runs the given revision with no narrowing so the raw side is always raw, then computes ``narrowed`` from the effective field map (request override → the revision's saved ``response_schema`` → none). Verifies the revision belongs to the caller's org AND to ``tool_id`` (404 otherwise). Persists nothing.

⌘I

Execute an API tool

curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/tools/{tool_id}/execute \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "input": {},
  "metadata": {}
}
'

{
  "status_code": 123,
  "headers": {},
  "body": "<unknown>",
  "success": true,
  "error": "<string>",
  "execution_time_ms": 123,
  "request_url": "<string>",
  "request_method": "<string>"
}