Skip to main content
POST
/
v1
/
tools
/
{tool_id}
/
revisions
/
{revision_id}
/
test
Preview a revision's RAW response + narrowed field map (no persist)
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/tools/{tool_id}/revisions/{revision_id}/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "input": {},
  "metadata": {},
  "response_field_map": {
    "field_mappings": [
      {
        "path": "<string>",
        "alias": "<string>"
      }
    ]
  }
}
'
{
  "status_code": 123,
  "headers": {},
  "body": "<unknown>",
  "narrowed": null,
  "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
revision_id
string<uuid>
required

Body

application/json

Preview a revision's response + narrowing without persisting (ENG-631).

Runs the revision's HTTP config and returns the RAW body plus a narrowed preview. response_field_map is an optional unsaved selection to preview; when omitted the router falls back to the revision's saved response_schema. Mirrors the integrations test-invoke surface.

input
Input · object
metadata
Metadata · object
response_field_map
ResponseFieldSelector · object

Defines which fields to extract from a tool response.

Response

Successful Response

Raw response body + narrowed preview for the dashboard field-map editor.

body is always the RAW upstream response (never narrowed). narrowed is what the agent would receive after applying the effective field map (request override → saved response_schema); None when no map applies.

status_code
integer
required
headers
Headers · object
body
any
narrowed
unknown
success
boolean
default:true
error
string | null
execution_time_ms
number | null
request_url
string | null
request_method
string | null