Run a tool

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)

[
  {}
]

{
  "error_type": "syntax_error",
  "error_code": "INVALID_QUERY",
  "status": "error",
  "message": "Invalid query syntax"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error_type": "syntax_error",
  "error_code": "INVALID_QUERY",
  "status": "error",
  "message": "Invalid query syntax"
}

{
  "error_type": "syntax_error",
  "error_code": "INVALID_QUERY",
  "status": "error",
  "message": "Invalid query syntax"
}

POST

projects

{project_id}

tools

{tool_id}

run

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)

[
  {}
]

{
  "error_type": "syntax_error",
  "error_code": "INVALID_QUERY",
  "status": "error",
  "message": "Invalid query syntax"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error_type": "syntax_error",
  "error_code": "INVALID_QUERY",
  "status": "error",
  "message": "Invalid query syntax"
}

{
  "error_type": "syntax_error",
  "error_code": "INVALID_QUERY",
  "status": "error",
  "message": "Invalid query syntax"
}

Authorizations

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

Tool execution successful

Concepts

Endpoints

Authorizations

Path Parameters

Body

Response