Get tool parameters schema

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));

[
  {
    "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

projects

{project_id}

tools

{tool_id}

parameters

Get tool parameters schema

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));

[
  {
    "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

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

Response

JSON schema describing the tool's run parameters

string

Parameter name (used as the JSON key when calling runTool).

type

enum<string>

JSON type of the parameter value.

Available options:

string,

integer,

number,

boolean,

array,

object

description

string

Human-readable description of the parameter.

required

boolean

Whether the parameter must be supplied when running the tool.

default

any

Default value when the parameter is omitted. Type matches type.