Create a new API tool

POST

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

Create a new API tool of various types (API, RAG, Web Search) in an organization

Path Parameters:

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

Request Body:

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

description (str): The description of the API tool.

headers (dict): The headers of the API tool.

base_template_id (int): The ID of the API tool template to use as a base for the new API tool.

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

Returns:

A new API tool for the specified organization.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///api/v2/organizations//tools/api-tools' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "headers": {
        "property1": null,
        "property2": null
    },
    "base_template_id": 0,
    "system_prompt": "string"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "name": "string",
        "description": "string",
        "org": 0,
        "tool_type": "rag",
        "created_by": "string",
        "is_enabled": true,
        "is_default": true,
        "connection": true,
        "headers": {
            "property1": null,
            "property2": null
        },
        "system_prompt": "string",
        "base_template": 0
    }
}

Request

Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

The created API tool

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Create a new API Tool Template

Create an attachment tool