Create a new API Tool Template

POST

/api/v2/organizations/{organization_id}/tools/api-tool-templates

Creates a new API Tool Template in an Organization.
The API Tool Template defines how the system should interact with external APIs using a customizable system prompt and status flag.

Path Parameters:

organization_id (int): The ID of the organization to create the API tool template for.

Request Body:

template_name (str): The name of the API tool template.

system_prompt (str): The system prompt for the API tool template.

is_enabled (bool): Whether the API tool template is enabled.

Returns:

A new API tool template for the specified organization.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Required

Examples

Responses

🟢201Created

application/json

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/organizations//tools/api-tool-templates' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "template_name": "string",
    "system_prompt": "string",
    "is_enabled": true
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "template_name": "string",
        "system_prompt": "string",
        "is_enabled": true
    }
}

Get all API Tool Templates

Create a new API tool