import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/{tool_id}/parameters/"
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/{tool_id}/parameters/', 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/{tool_id}/parameters/ \
--header 'Authorization: Bearer <token>'[
{
"id": "query",
"type": "string",
"description": "Query to search for chunks.",
"default": "",
"required": false
},
{
"id": "top_k",
"type": "integer",
"description": "Number of objects to retrieve. For initial search use the default top_k value : 10.",
"default": 10,
"required": false
}
]Get tool parameters schema
Return the JSON schema describing the parameters accepted by
runTool for this tool.
The schema is a list of parameter specs (id, type, description,
required, and an optional default). The exact list depends on the
tool’s tool_type and configuration — for example a retrieval tool
configured with auto_include tags exposes an extra included_tags
parameter.
Use the id of each entry as the key in the JSON body sent to
runTool.
import requests
url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/tools/{tool_id}/parameters/"
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/{tool_id}/parameters/', 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/{tool_id}/parameters/ \
--header 'Authorization: Bearer <token>'[
{
"id": "query",
"type": "string",
"description": "Query to search for chunks.",
"default": "",
"required": false
},
{
"id": "top_k",
"type": "integer",
"description": "Number of objects to retrieve. For initial search use the default top_k value : 10.",
"default": 10,
"required": false
}
]Authorizations
Use Authorization: Bearer <token>. The token is either a user token / OAuth access
token, or a service-account API key (cfk_...). A key is valid on every endpoint and
acts as its service account, an organization member with per-store permissions.
Refused keys answer 403 with Invalid API key., API key revoked.,
API key expired. or API key disabled..
Path Parameters
UUID of the project
UUID of the tool
Response
JSON schema describing the tool's run parameters
Parameter name (used as the JSON key when calling runTool).
JSON type of the parameter value.
string, integer, number, boolean, array, object Human-readable description of the parameter.
Whether the parameter must be supplied when running the tool.
Default value when the parameter is omitted. Type matches type.