Skip to main content
GET
/
tools
/
{tool_name}
Python
import os
from datagrid_ai import Datagrid

client = Datagrid(
    api_key=os.environ.get("DATAGRID_API_KEY"),  # This is the default and can be omitted
)
tool_def = client.tools.retrieve(
    "data_analysis",
)
print(tool_def.description)
{
  "object": "tool",
  "name": "<string>",
  "label": "<string>",
  "description": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
tool_name
required

The name of the tool to retrieve.

Available options:
data_analysis,
semantic_search,
agent_memory,
schema_info,
table_info,
create_dataset,
find_files,
read_file_contents,
file_analysis,
calendar,
email,
schedule_recurring_message_tool,
procore,
egnyte,
notion,
slack,
microsoft_teams,
sharepoint,
drive,
fieldwire,
planner,
webbrowser,
pdf_manipulation,
pdf_generator,
acc,
docusign,
webflow,
hubspot,
nec,
github,
trimble_project_site,
trimble,
linkedin,
google_docs,
google_slides,
google_sheets,
avoma,
content_writer,
code_tool,
data_classification,
data_extraction,
image_detection,
attachment_extraction,
pdf_extraction,
pdf_page_info,
youtube_video_analysis,
calculate,
pdf_form_filling,
image_generator,
video_generator,
connect_data,
download_data,
web_search,
fetch_url,
company_prospect_researcher,
people_prospect_researcher

Response

200 - application/json

Retrieved tool

The Tool object represents a tool that can be used by agents.

​
object
enum<string>
required

The object type, which is always tool.

Available options:
tool
​
name
string
required

The unique identifier name used to reference the tool.

​
label
string
required

The display name of the tool.

​
description
string
required

A detailed description of what the tool does.