Skip to main content
GET
/
api
/
v1
/
tools
/
{tool_id}
Get Tool
curl --request GET \
  --url https://api.voicebot.studio/api/v1/tools/{tool_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "type": "<string>",
  "function": {
    "strict": true,
    "name": "<string>",
    "description": "<string>",
    "parameters": {
      "type": "object",
      "properties": {},
      "required": [
        "<string>"
      ]
    }
  },
  "server": {
    "timeoutSeconds": 20,
    "url": "<string>",
    "secret": "<string>",
    "headers": {}
  },
  "messages": [
    {
      "contents": [
        {
          "type": "text",
          "text": "<string>",
          "language": "aa"
        }
      ],
      "type": "request-start",
      "content": "<string>",
      "conditions": [
        {
          "operator": "eq",
          "param": "<string>",
          "value": {}
        }
      ]
    }
  ],
  "organizationId": "<string>",
  "createdBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

X-API-Key
string
header
required

Path Parameters

tool_id
string
required

Response

Successful Response

id
string
required
type
string
required
organizationId
string
required
createdBy
string
required
createdAt
string
required
updatedAt
string
required
function
object | null
server
object | null
messages
Messages · array