Tools

PreviousPrediction NextUpsert History

Last updated 28 days ago

Create a new tool

post

/tools

Authorizations

Body

idstring · uuid

Unique identifier for the tool

Example: cfd531e0-82fc-11e9-bc42-526af7764f64

namestring

Name of the tool

Example: date_time_tool

descriptionstring

Description of the tool

Example: A tool used for date and time operations

colorstring

Color associated with the tool

Example: #FF5733

iconSrcstring | nullable

Source URL for the tool's icon

Example: https://example.com/icons/date.png

schemastring | nullable

JSON schema associated with the tool

funcstring | nullable

Functionality description or code associated with the tool

createdDatestring · date-time

Date and time when the tool was created

Example: 2024-08-24T14:15:22Z

updatedDatestring · date-time

Date and time when the tool was last updated

Example: 2024-08-24T14:15:22Z

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/tools' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"cfd531e0-82fc-11e9-bc42-526af7764f64","name":"date_time_tool","description":"A tool used for date and time operations","color":"#FF5733","iconSrc":"https://example.com/icons/date.png","createdDate":"2024-08-24T14:15:22Z","updatedDate":"2024-08-24T14:15:22Z"}'

200

400

422

500

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "date_time_tool",
  "description": "A tool used for date and time operations",
  "color": "#FF5733",
  "iconSrc": "https://example.com/icons/date.png",
  "schema": "text",
  "func": "text",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Tool created successfully

List all tools

Retrieve a list of all tools

get

/tools

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/tools' \
  --header 'Authorization: Bearer JWT'

200

500

[
  {
    "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
    "name": "date_time_tool",
    "description": "A tool used for date and time operations",
    "color": "#FF5733",
    "iconSrc": "https://example.com/icons/date.png",
    "schema": "text",
    "func": "text",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }
]

Successful operation

Get a tool by ID

Retrieve a specific tool by ID

get

/tools/{id}

Authorizations

Path parameters

idstringrequired

Tool ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/tools/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "date_time_tool",
  "description": "A tool used for date and time operations",
  "color": "#FF5733",
  "iconSrc": "https://example.com/icons/date.png",
  "schema": "text",
  "func": "text",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Successful operation

Update a tool by ID

Update a specific tool by ID

put

/tools/{id}

Authorizations

Path parameters

idstringrequired

Tool ID

Body

idstring · uuid

Unique identifier for the tool

Example: cfd531e0-82fc-11e9-bc42-526af7764f64

namestring

Name of the tool

Example: date_time_tool

descriptionstring

Description of the tool

Example: A tool used for date and time operations

colorstring

Color associated with the tool

Example: #FF5733

iconSrcstring | nullable

Source URL for the tool's icon

Example: https://example.com/icons/date.png

schemastring | nullable

JSON schema associated with the tool

funcstring | nullable

Functionality description or code associated with the tool

createdDatestring · date-time

Date and time when the tool was created

Example: 2024-08-24T14:15:22Z

updatedDatestring · date-time

Date and time when the tool was last updated

Example: 2024-08-24T14:15:22Z

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/tools/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"id":"cfd531e0-82fc-11e9-bc42-526af7764f64","name":"date_time_tool","description":"A tool used for date and time operations","color":"#FF5733","iconSrc":"https://example.com/icons/date.png","createdDate":"2024-08-24T14:15:22Z","updatedDate":"2024-08-24T14:15:22Z"}'

200

400

404

500

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "date_time_tool",
  "description": "A tool used for date and time operations",
  "color": "#FF5733",
  "iconSrc": "https://example.com/icons/date.png",
  "schema": "text",
  "func": "text",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Tool updated successfully

Delete a tool by ID

Delete a specific tool by ID

delete

/tools/{id}

Authorizations

Path parameters

idstringrequired

Tool ID

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/tools/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

No body

Tool deleted successfully