List tools
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/ \
--header 'Authorization: Bearer <token>'{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "4f4a0a36-2c3d-4e6c-9a3b-2b1f0f1a2c11",
"name": "Search financial chunks",
"description": "Semantic search over chunks tagged as financial reports.",
"tool_type": "retrieval",
"retrieval_mode": "semantic-chunks",
"retrieval_parameters": {
"n_objects": 10,
"rerank": true,
"reformulate_query": false
},
"tool_parameters": {},
"document_mode": "include_all",
"document_parameters": [],
"tags_included_mode": "include_all",
"tags_included_parameters": [],
"tags_excluded_mode": "exclude_none",
"tags_excluded_parameters": [],
"objects_included_mode": "include_all",
"objects_included_parameters": [],
"objects_excluded_mode": "exclude_none",
"objects_excluded_parameters": [],
"attributes_included_mode": "include_all",
"attributes_included_parameters": {},
"attributes_excluded_mode": "exclude_none",
"attributes_excluded_parameters": {},
"search_scope_extensions": {},
"category": "local",
"owner_project_id": "9c2b1c0a-7a1d-4d1d-8e3a-1d2b3c4d5e6f",
"owner_project_name": "Finance Analytics",
"exported_to_count": 0,
"exported_to": [],
"readonly": false,
"created_by": "7e9c0c11-22e0-4d4a-9a3b-9c8e7d6f5a4b",
"created_at": "2026-04-12T10:21:33Z",
"updated_at": "2026-05-02T08:44:01Z"
},
{
"id": "c1a7f2e0-6e8f-4f0a-9d11-8b6e5d4c3b2a",
"name": "Document retrieval (annual reports)",
"description": "Retrieve documents by name or tag.",
"tool_type": "document_retrieval",
"retrieval_mode": "semantic-chunks",
"retrieval_parameters": {},
"tool_parameters": {},
"document_mode": "include_all",
"document_parameters": [],
"tags_included_mode": "include_all",
"tags_included_parameters": [],
"tags_excluded_mode": "exclude_none",
"tags_excluded_parameters": [],
"objects_included_mode": "include_all",
"objects_included_parameters": [],
"objects_excluded_mode": "exclude_none",
"objects_excluded_parameters": [],
"attributes_included_mode": "include_all",
"attributes_included_parameters": {},
"attributes_excluded_mode": "exclude_none",
"attributes_excluded_parameters": {},
"search_scope_extensions": {},
"category": "imported",
"owner_project_id": "11111111-2222-3333-4444-555555555555",
"owner_project_name": "Shared Tools",
"exported_to_count": 0,
"exported_to": [],
"readonly": true,
"created_by": "7e9c0c11-22e0-4d4a-9a3b-9c8e7d6f5a4b",
"created_at": "2026-03-08T15:02:11Z",
"updated_at": "2026-04-22T11:30:00Z"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Tools
List tools
List all tools available to the project, including tools owned by the
project (category: local) and tools imported from other projects
(category: imported).
Use the returned id together with
getToolParameters to discover the
request body schema for a given tool, then call
runTool to execute it.
GET
/
projects
/
{project_id}
/
tools
/
List tools
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/ \
--header 'Authorization: Bearer <token>'{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": "4f4a0a36-2c3d-4e6c-9a3b-2b1f0f1a2c11",
"name": "Search financial chunks",
"description": "Semantic search over chunks tagged as financial reports.",
"tool_type": "retrieval",
"retrieval_mode": "semantic-chunks",
"retrieval_parameters": {
"n_objects": 10,
"rerank": true,
"reformulate_query": false
},
"tool_parameters": {},
"document_mode": "include_all",
"document_parameters": [],
"tags_included_mode": "include_all",
"tags_included_parameters": [],
"tags_excluded_mode": "exclude_none",
"tags_excluded_parameters": [],
"objects_included_mode": "include_all",
"objects_included_parameters": [],
"objects_excluded_mode": "exclude_none",
"objects_excluded_parameters": [],
"attributes_included_mode": "include_all",
"attributes_included_parameters": {},
"attributes_excluded_mode": "exclude_none",
"attributes_excluded_parameters": {},
"search_scope_extensions": {},
"category": "local",
"owner_project_id": "9c2b1c0a-7a1d-4d1d-8e3a-1d2b3c4d5e6f",
"owner_project_name": "Finance Analytics",
"exported_to_count": 0,
"exported_to": [],
"readonly": false,
"created_by": "7e9c0c11-22e0-4d4a-9a3b-9c8e7d6f5a4b",
"created_at": "2026-04-12T10:21:33Z",
"updated_at": "2026-05-02T08:44:01Z"
},
{
"id": "c1a7f2e0-6e8f-4f0a-9d11-8b6e5d4c3b2a",
"name": "Document retrieval (annual reports)",
"description": "Retrieve documents by name or tag.",
"tool_type": "document_retrieval",
"retrieval_mode": "semantic-chunks",
"retrieval_parameters": {},
"tool_parameters": {},
"document_mode": "include_all",
"document_parameters": [],
"tags_included_mode": "include_all",
"tags_included_parameters": [],
"tags_excluded_mode": "exclude_none",
"tags_excluded_parameters": [],
"objects_included_mode": "include_all",
"objects_included_parameters": [],
"objects_excluded_mode": "exclude_none",
"objects_excluded_parameters": [],
"attributes_included_mode": "include_all",
"attributes_included_parameters": {},
"attributes_excluded_mode": "exclude_none",
"attributes_excluded_parameters": {},
"search_scope_extensions": {},
"category": "imported",
"owner_project_id": "11111111-2222-3333-4444-555555555555",
"owner_project_name": "Shared Tools",
"exported_to_count": 0,
"exported_to": [],
"readonly": true,
"created_by": "7e9c0c11-22e0-4d4a-9a3b-9c8e7d6f5a4b",
"created_at": "2026-03-08T15:02:11Z",
"updated_at": "2026-04-22T11:30:00Z"
}
]
}{
"error": "Authentication credentials were not provided."
}{
"error": "You do not have permission to perform this action."
}{
"error": "Not found."
}Authorizations
BearerAuthTokenAuth
Use Authorization: Bearer
Path Parameters
UUID of the project
Query Parameters
Filter by tool type
Category of tool, which controls how it is executed and what
parameters it accepts. The retrieval family additionally exposes a
retrieval_mode field (e.g. semantic-chunks, semantic-objects,
templated-query).
Available options:
retrieval, math, document_retrieval, data_statistics, websearch, sub_agent Maximum number of results per page
Required range:
1 <= x <= 1000Number of results to skip for pagination
Required range:
x >= 0