Skip to main content
POST
/
api
/
admin
/
tool
Create a new tool
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/tool \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "<string>",
  "schema": {},
  "endpoint": "<string>",
  "status": "active",
  "institution": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "responseLength": 123,
    "responseDurationMs": 123,
    "success": true,
    "_id": "<string>",
    "description": "<string>",
    "type": "<string>",
    "schema": {},
    "endpoint": "<string>",
    "status": "active",
    "institution": "<string>",
    "created": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
name
string
required

Tool name

description
string
required

Tool description

type
string

Tool type

schema
object

Tool JSON schema

endpoint
string

Tool endpoint URL

status
enum<string>
default:active
Available options:
active,
inactive
institution
string

Institution ID

Response

Tool created successfully

success
boolean
data
object