List Tools

List all tools.

GET /api/v1/tools

List Tools

cURL

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

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/tools"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://{tenant_id}.api.useago.com/api/v1/tools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

200

{
  "data": [
    {
      "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": []
    }
  ],
  "has_more": true,
  "total": 123,
  "object": "list"
}

Authorizations

X-API-Key · string · header · required

Query Parameters

page · integer · default: 1

page_size · integer · default: 50

Response

200 - application/json

OK

Paginated list response for tools.

data · ToolOut · object[] · required

Show child attributes

has_more · boolean · required

total · integer · required

object · string · default: list