UBIK Agent will launch soon, join the waitlist to get access!
import requests
url = "https://app.ubik-agent.com/api/v1/tools/{tool_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "d1e2f3a4-b5c6-7890-1234-567890abcdef",
"name": "Financial Data Extractor",
"description": "Extracts key financial metrics from annual reports.",
"input_schema": {
"type": "object",
"properties": {
"stock_symbol": {
"type": "string",
"description": "The stock symbol of the company."
},
"report_year": {
"type": "integer",
"description": "The year of the financial report."
}
},
"required": [
"stock_symbol",
"report_year"
]
},
"media_output_keys": [],
"example_responses": [
{
"revenue": 1000000,
"profit": 250000
}
],
"pricing_config": {
"fixed_cost": 0.01
}
}Retrieves the details of a specific tool, provided the user has access.
import requests
url = "https://app.ubik-agent.com/api/v1/tools/{tool_id}"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"id": "d1e2f3a4-b5c6-7890-1234-567890abcdef",
"name": "Financial Data Extractor",
"description": "Extracts key financial metrics from annual reports.",
"input_schema": {
"type": "object",
"properties": {
"stock_symbol": {
"type": "string",
"description": "The stock symbol of the company."
},
"report_year": {
"type": "integer",
"description": "The year of the financial report."
}
},
"required": [
"stock_symbol",
"report_year"
]
},
"media_output_keys": [],
"example_responses": [
{
"revenue": 1000000,
"profit": 250000
}
],
"pricing_config": {
"fixed_cost": 0.01
}
}The unique identifier or name of the tool.
Successful Response
The unique identifier for the tool.
The name of the tool.
The JSON schema defining the inputs for the tool.
Hide child attributes
An object defining the properties of the input object.
Hide child attributes
Hide child attributes
The data type of the property (e.g., 'string', 'integer', or ['string', 'null']).
A description of what the property represents.
A list of possible values if the property is an enumeration.
A list of property names that are required.
Hide child attributes
Hide child attributes
The data type of the property (e.g., 'string', 'integer', or ['string', 'null']).
A description of what the property represents.
A list of possible values if the property is an enumeration.
A list of keys in the output that contain media URLs.
A list of example inputs and their corresponding outputs for the tool.
A brief description of what the tool does.
Was this page helpful?