Test a tool

curl --request POST \
  --url https://sandbox.voice.miraiminds.co/v2/agents/{agent_id}/tools/{tool_name}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": {
    "date": "2026-10-18",
    "time": "10:30"
  },
  "vars": {
    "customer_id": "cus_42"
  }
}
'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/agents/{agent_id}/tools/{tool_name}/test"

payload = {
    "args": {
        "date": "2026-10-18",
        "time": "10:30"
    },
    "vars": { "customer_id": "cus_42" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/agents/{agent_id}/tools/{tool_name}/test';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({args: {date: '2026-10-18', time: '10:30'}, vars: {customer_id: 'cus_42'}})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "tool": "book_slot",
  "phase": "on_call",
  "kind": "http",
  "tool_run_id": "trun_4c7e19a0b25d83f6e0a91d58",
  "condition": {
    "result": true,
    "failed_leaf": ""
  },
  "request": {
    "method": "POST",
    "url": "https://api.example.com/service/bookings",
    "headers": {
      "Authorization": "Bearer «secret:crm_key»",
      "Content-Type": "application/json"
    },
    "body": {
      "customer_id": "cus_42",
      "date": "2026-10-18",
      "time": "10:30"
    }
  },
  "response": {
    "status": 200,
    "ms": 240,
    "body_preview": "{\"booking_id\":\"bk_7731\",\"slot\":\"2026-10-18T10:30:00+05:30\",\"status\":\"confirmed\"}"
  },
  "transform": {
    "output": {
      "booking_id": "bk_7731",
      "slot": "2026-10-18T10:30:00+05:30"
    }
  },
  "promoted": {},
  "missing": [],
  "would": "run",
  "status": "ok"
}

Tools and secrets

Test a tool

Runs the saved tool once, for real, against your endpoint, with values you supply, and shows exactly what happened: whether its condition held, the request as sent (secrets masked), the reply, what your transform made of it, what would be promoted, which template paths were empty, and whether a call would run, skip or abort. It places no call. Use test data for tools that book, charge or send messages.

The body is optional: args (what the model would pass), vars, call and analysis. Check status as well as the HTTP code: a tool that failed still comes back as a 200 with the failed run in it. With this section’s example URL the request can’t connect; point the tool at your own endpoint first.

POST

agents

{agent_id}

tools

{tool_name}

test

Test a tool

curl --request POST \
  --url https://sandbox.voice.miraiminds.co/v2/agents/{agent_id}/tools/{tool_name}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "args": {
    "date": "2026-10-18",
    "time": "10:30"
  },
  "vars": {
    "customer_id": "cus_42"
  }
}
'

import requests

url = "https://sandbox.voice.miraiminds.co/v2/agents/{agent_id}/tools/{tool_name}/test"

payload = {
    "args": {
        "date": "2026-10-18",
        "time": "10:30"
    },
    "vars": { "customer_id": "cus_42" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const url = 'https://sandbox.voice.miraiminds.co/v2/agents/{agent_id}/tools/{tool_name}/test';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({args: {date: '2026-10-18', time: '10:30'}, vars: {customer_id: 'cus_42'}})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "tool": "book_slot",
  "phase": "on_call",
  "kind": "http",
  "tool_run_id": "trun_4c7e19a0b25d83f6e0a91d58",
  "condition": {
    "result": true,
    "failed_leaf": ""
  },
  "request": {
    "method": "POST",
    "url": "https://api.example.com/service/bookings",
    "headers": {
      "Authorization": "Bearer «secret:crm_key»",
      "Content-Type": "application/json"
    },
    "body": {
      "customer_id": "cus_42",
      "date": "2026-10-18",
      "time": "10:30"
    }
  },
  "response": {
    "status": 200,
    "ms": 240,
    "body_preview": "{\"booking_id\":\"bk_7731\",\"slot\":\"2026-10-18T10:30:00+05:30\",\"status\":\"confirmed\"}"
  },
  "transform": {
    "output": {
      "booking_id": "bk_7731",
      "slot": "2026-10-18T10:30:00+05:30"
    }
  },
  "promoted": {},
  "missing": [],
  "would": "run",
  "status": "ok"
}

Authorizations

Authorization

string

header

required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Path Parameters

agent_id

string

required

The agent's id (agt_…).

tool_name

string

required

The tool's name on the agent: lowercase letters, digits and underscores.

Body

application/json

analysis

object

Show child attributes

args

object

Show child attributes

call

object

Show child attributes

vars

object

Show child attributes

Response

Your endpoint answered

Get started

Agents

Calls

Flows

Tools and secrets

Campaigns

Do-not-call list

Phone numbers

Phone pools

Telephony

Transcriptions

Speech to text

Text to speech

Wallet

Reference

Test a tool

Authorizations

Path Parameters

Body

Response