Create Tool

Create a new tool.

POST /api/v1/tools

Create Tool

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/tools \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "tool_type_id": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "secret_key": "<string>",
  "additional_info": {},
  "prompt": "<string>",
  "input_schema": {},
  "sources_restrictions": [
    "<string>"
  ],
  "strict_mode": false,
  "forward_user_auth": false,
  "admin_tags": [
    "<string>"
  ],
  "required_permissions": [
    "<string>"
  ]
}
'

201

{
  "id": "<string>",
  "name": "<string>",
  "object": "tool",
  "display_name": "<string>",
  "description": "<string>",
  "tool_type": {
    "id": "<string>",
    "name": "<string>",
    "class_name": "<string>",
    "object": "tool_type",
    "description": "<string>",
    "additional_info_schema": {},
    "prompt": "<string>"
  },
  "additional_info": {},
  "prompt": "<string>",
  "input_schema": {},
  "strict_mode": false,
  "forward_user_auth": false,
  "sources_restrictions": [],
  "admin_tags": [],
  "required_permissions": []
}

Authorizations

X-API-Key · string · header · required

Body

application/json

Schema for creating a tool via the v1 API.

name · string · required

tool_type_id · string · required

display_name · string | null

description · string | null

secret_key · string | null

additional_info · Additional Info · object | null

prompt · string | null

input_schema · Input Schema · object | null

sources_restrictions · string[] | null

strict_mode · boolean | null · default: false

forward_user_auth · boolean | null · default: false

admin_tags · string[] | null

required_permissions · string[] | null

Response

201 - application/json

Created

Response schema for tools.

id · string · required

name · string · required

object · string · default: tool

display_name · string | null

description · string | null

tool_type · ToolTypeOut · object | null

Response schema for tool types.

Show child attributes

additional_info · Additional Info · object | null

prompt · string | null

input_schema · Input Schema · object | null

strict_mode · boolean · default: false

forward_user_auth · boolean · default: false

sources_restrictions · Sources Restrictions · object[]

admin_tags · Admin Tags · object[]

required_permissions · Required Permissions · object[]