Get Tool

Get a tool by ID.

GET /api/v1/tools/{tool_id}

Get Tool

cURL

curl --request GET \
  --url https://{tenant_id}.api.useago.com/api/v1/tools/{tool_id} \
  --header 'X-API-Key: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "object": "tool",
  "display_name": "<string>",
  "description": "<string>",
  "tool_type": {
    "id": "<string>",
    "name": "<string>",
    "class_name": "<string>",
    "object": "tool_type",
    "description": "<string>",
    "additional_info_schema": {},
    "prompt": "<string>"
  },
  "additional_info": {},
  "prompt": "<string>",
  "input_schema": {},
  "strict_mode": false,
  "forward_user_auth": false,
  "sources_restrictions": [],
  "admin_tags": [],
  "required_permissions": []
}

Authorizations

X-API-Key · string · header · required

Path Parameters

tool_id · string · required

Response

200 - application/json

OK

Response schema for tools.

id · string · required

name · string · required

object · string · default: tool

display_name · string | null

description · string | null

tool_type · ToolTypeOut · object | null

Response schema for tool types.

Show child attributes

additional_info · Additional Info · object | null

prompt · string | null

input_schema · Input Schema · object | null

strict_mode · boolean · default: false

forward_user_auth · boolean · default: false

sources_restrictions · Sources Restrictions · object[]

admin_tags · Admin Tags · object[]

required_permissions · Required Permissions · object[]