POST
/
{resourceSlug}
/
forms
/
tool
/
{toolId}
/
edit

Path Parameters

resourceSlug
string
required

The resourceSlug is a URL parameter of the teamId associated with the user. Anywhere the resourceSlug is used can be interpreted as a teamId.

toolId
string
required

The ID of the tool to be edited.

Body

tool.json
_id
string

Mongodb Object id, unique identifier, length of 24 characters fitting the following regex; [a-f0-9]{24}

orgId
string

Identifier of the organization to which the tool belongs.

teamId
string

Identifier of the team to which the tool belongs.

name
string
required

The name of the tool.

description
string
required

A detailed description of the tool.

type
enum<string>
required

The type of tool.

Available options:
function,
rag
asdf
string

The schema associated with the tool.

retriever_type
enum<string>

The type of retriever used by the tool.

Available options:
raw,
self_query,
time_weighted,
multi_query
retriever_config
object

Configuration settings for the retriever.

datasourceId
string

Identifier of the datasource associated with the tool.

state
enum<string>

The current state of the tool.

Available options:
pending,
ready,
error
data
object
required

Data related to the tool, including runtime, environment variables, and more.

icon
object

Icon associated with the tool.

hidden
boolean

Indicates whether the tool is hidden.

functionId
string

Identifier of the function associated with the tool.

revisionId
string

Identifier of the tool's revision.

functionLogs
string

Logs related to the function's execution.

Response

302 - dynamicResponse
_id
string

The unique Mongo id of the newly inserted object.

redirect
string

a string containing the redirect link to get all objects after a successful insertion.

Add A New ToolDelete A Tool