Tools

Create a new tool

post

Create a new tool

Authorizations

Body

idstring · uuidOptional

Unique identifier for the tool

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

namestringOptional

Name of the tool

Example: date_time_tool

descriptionstringOptional

Description of the tool

Example: A tool used for date and time operations

colorstringOptional

Color associated with the tool

Example: #FF5733

iconSrcstring | nullableOptional

Source URL for the tool's icon

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

schemastring | nullableOptional

JSON schema associated with the tool

funcstring | nullableOptional

Functionality description or code associated with the tool

createdDatestring · date-timeOptional

Date and time when the tool was created

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

updatedDatestring · date-timeOptional

Date and time when the tool was last updated

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

Responses

200

Tool created successfully

application/json

400

Invalid request body

422

Validation error

500

Internal server error

post

POST /tools HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 295

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

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

List all tools

get

Retrieve a list of all tools

Authorizations

Responses

200

Successful operation

application/json

500

Internal server error

get

GET /tools HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

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

Get a tool by ID

get

Retrieve a specific tool by ID

Authorizations

Path parameters

idstringRequired

Tool ID

Responses

200

Successful operation

application/json

400

Invalid ID provided

404

Tool not found

500

Internal server error

get

GET /tools/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

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

Update a tool by ID

put

Update a specific tool by ID

Authorizations

Path parameters

idstringRequired

Tool ID

Body

idstring · uuidOptional

Unique identifier for the tool

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

namestringOptional

Name of the tool

Example: date_time_tool

descriptionstringOptional

Description of the tool

Example: A tool used for date and time operations

colorstringOptional

Color associated with the tool

Example: #FF5733

iconSrcstring | nullableOptional

Source URL for the tool's icon

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

schemastring | nullableOptional

JSON schema associated with the tool

funcstring | nullableOptional

Functionality description or code associated with the tool

createdDatestring · date-timeOptional

Date and time when the tool was created

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

updatedDatestring · date-timeOptional

Date and time when the tool was last updated

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

Responses

200

Tool updated successfully

application/json

400

Invalid ID or request body provided

404

Tool not found

500

Internal server error

put

PUT /tools/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 295

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

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

Delete a tool by ID

delete

Delete a specific tool by ID

Authorizations

Path parameters

idstringRequired

Tool ID

Responses

200

Tool deleted successfully

400

Invalid ID provided

404

Tool not found

500

Internal server error

delete

DELETE /tools/{id} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*

No content

PreviousPrediction NextUpsert History

Last updated 4 months ago