Get Tool By ID

Gets a tool, this route must use the new V3 endpoints.

GET /tools/{toolId}

Get a tool by id

cURL

curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/tools/{toolId} \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "isDefault": true,
    "serverUrl": "<string>",
    "serverUrlSecret": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "disabled": true,
    "isVapiTool": true,
    "vapiId": "<string>",
    "isGlobal": true,
    "variablesIds": [
      "<string>"
    ],
    "agentId": "<string>",
    "userId": "<string>",
    "backchannellingPhrases": [
      "<string>"
    ],
    "toolsSettings": "<unknown>",
    "fields": [
      {
        "id": "<string>",
        "in": "<string>",
        "value": "<unknown>",
        "defaultValue": "<unknown>",
        "key": "<string>",
        "description": "<string>",
        "required": true,
        "reusable": true,
        "isEnv": true,
        "isSystem": true,
        "isGlobal": true,
        "agentId": "<string>",
        "userId": "<string>"
      }
    ],
    "channels": []
  }
}

Returns full tool configuration including fields, server URL, and channel settings.

Use this endpoint to inspect a tool’s field configuration before making updates.

Authorizations

Authorization · string · header · required

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

Path Parameters

toolId · string · required

Response

200

application/json

Successful response

success · boolean · required

message · string · required

data · object · required

Show child attributes