Skip to main content
PUT
/
api
/
admin
/
tool
/
{id}
Update tool
curl --request PUT \
  --url https://pria.praxislxp.com/api/admin/tool/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "instructions": "<string>",
  "argument_1": "<string>",
  "argument_2": "<string>",
  "argument_3": "<string>",
  "argument_4": "<string>",
  "argument_5": "<string>",
  "argument_6": "<string>",
  "isArray": true,
  "rtEnabled": true,
  "rtOnly": true,
  "categories": []
}
'
import requests

url = "https://pria.praxislxp.com/api/admin/tool/{id}"

payload = {
"name": "<string>",
"description": "<string>",
"instructions": "<string>",
"argument_1": "<string>",
"argument_2": "<string>",
"argument_3": "<string>",
"argument_4": "<string>",
"argument_5": "<string>",
"argument_6": "<string>",
"isArray": True,
"rtEnabled": True,
"rtOnly": True,
"categories": []
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
instructions: '<string>',
argument_1: '<string>',
argument_2: '<string>',
argument_3: '<string>',
argument_4: '<string>',
argument_5: '<string>',
argument_6: '<string>',
isArray: true,
rtEnabled: true,
rtOnly: true,
categories: []
})
};

fetch('https://pria.praxislxp.com/api/admin/tool/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/admin/tool/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'instructions' => '<string>',
'argument_1' => '<string>',
'argument_2' => '<string>',
'argument_3' => '<string>',
'argument_4' => '<string>',
'argument_5' => '<string>',
'argument_6' => '<string>',
'isArray' => true,
'rtEnabled' => true,
'rtOnly' => true,
'categories' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://pria.praxislxp.com/api/admin/tool/{id}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"argument_1\": \"<string>\",\n \"argument_2\": \"<string>\",\n \"argument_3\": \"<string>\",\n \"argument_4\": \"<string>\",\n \"argument_5\": \"<string>\",\n \"argument_6\": \"<string>\",\n \"isArray\": true,\n \"rtEnabled\": true,\n \"rtOnly\": true,\n \"categories\": []\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("x-access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://pria.praxislxp.com/api/admin/tool/{id}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"argument_1\": \"<string>\",\n \"argument_2\": \"<string>\",\n \"argument_3\": \"<string>\",\n \"argument_4\": \"<string>\",\n \"argument_5\": \"<string>\",\n \"argument_6\": \"<string>\",\n \"isArray\": true,\n \"rtEnabled\": true,\n \"rtOnly\": true,\n \"categories\": []\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://pria.praxislxp.com/api/admin/tool/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"instructions\": \"<string>\",\n \"argument_1\": \"<string>\",\n \"argument_2\": \"<string>\",\n \"argument_3\": \"<string>\",\n \"argument_4\": \"<string>\",\n \"argument_5\": \"<string>\",\n \"argument_6\": \"<string>\",\n \"isArray\": true,\n \"rtEnabled\": true,\n \"rtOnly\": true,\n \"categories\": []\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "id": "<string>",
  "message": "<string>"
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Path Parameters

id
string
required

Tool ObjectId

Body

application/json

Partial update — only fields present in the body are written. The handler calls Tool.updateOne({_id}, body) with whatever is supplied; no field is required.

name
string
description
string
instructions
string
argument_1
string
argument_2
string
argument_3
string
argument_4
string
argument_5
string
argument_6
string
isArray
boolean
rtEnabled
boolean
rtOnly
boolean
categories
enum<string>[]
Available options:
research,
productivity,
creative,
communication,
learning
status
enum<string>
Available options:
active,
inactive,
deleted

Response

Tool updated successfully

success
boolean
id
string

ObjectId of the updated tool

message
string