Run a tool

Execute a configured tool with provided parameters.

The request body varies based on the tool type. Most tools accept a query parameter and optional parameters like top_k for controlling result count.

POST /projects/{project_id}/tools/{tool_id}/run

Python

retrieval

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/{tool_id}/run/"

payload = {
    "query": "What are the key findings about revenue growth?",
    "top_k": 10
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

[
  {}
]

Authorizations

BearerAuthTokenAuth

Authorization · string · header · required

Use Authorization: Bearer

Path Parameters

project_id · string<uuid> · required

UUID of the project

tool_id · string<uuid> · required

UUID of the tool

Body

application/json

Request body for running a tool. Parameters vary by tool type. Most tools accept a query parameter and optional top_k for result count.

query · string

The search query or input for the tool

Example:

"What are the key findings about revenue growth?"

top_k · integer · default: 10

Maximum number of results to return

Example:

10

Response

200

application/json

Tool execution successful