Update a GPT tool

Update a GPT tool. The copilot and type cannot be changed.

To replace a Data Query tool's file, send POST /gpttools/{id} as multipart/form-data with the new file.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

Identifier

Body Params
configuration
object

Data Query settings:

  • resource_guid or resource_name: query a resource instead of url (not both)
  • data_path: where the rows are inside a nested JSON file, for example b for {"a": 1, "b": [...]}
  • template: 1 to use the built-in description for a parts list, so description is optional
dependencies
array | null

Conditional visibility rules: [operator, [conditions]] with "AND"/"OR" groups (nestable) of {variable, operator, targets, path} conditions. See the Dependencies reference for the full format and multi-condition examples.

dependencies
string
length ≤ 500

When the GPT should use the tool and what it does

number

Position in the copilot's tool list

string | null

How the GPT should format what the tool returns

parameters
array of objects

Inputs the GPT fills in when it calls the tool

parameters
string
length ≤ 100
roles
array of integers

User levels the tool is used for. Valid 0=User, 1=Tech, 2=Tech2, 3=Tech3, 5=Expert, 7=User2, 8=User3.

roles
string

JavaScript run on the script server (Script tools).

Returned only when requested with ?expand=script.

Returned only when requested with ?expand=script.

integer
enum

1 the GPT can use the tool, 0 it can't

Allowed:
string | null

undefined (Allowed extensions: csv, tsv, xlsx)

Responses

403

The caller can't edit this copilot (Script tools)

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json