Waiting for engine...
Skip to main content

aiAgentToolCreate

Updated 

Create a new AI Agent Tool in the AI Agent Registry.

Description: This mutation creates a new AI Agent Tool associated with the authenticated user’s account. Tools will always associate with DRAFT version of task.

Input Parameters (AiAgentToolCreateInput):

  • providerAccountId: ID! - Required. The unique identifier of the AI Agent Custom Type Provider account where the tool will be created.
  • toolType: AiAgentToolType! - Required. Specifies the classification type of the AI Agent tool.
  • name: String! - Required. Defines the unique identifier or title of the AI agent tool.
  • description: String - Optional. Provides detailed information about the AI agent tool's capabilities and features.
  • toolJson: String - Optional. Stores the complete tool configuration represented as a JSON string.
  • resources: [AiAgentToolResourceInput!] - Optional. Array of tool resources associated with the AI Agent tool.
  • tags: [AiAgentTagInput!] - Optional. Optional labeling system that allows classification and organization of AI agent tools.
  • aiAgentTaskIds: [ID!] - Optional. List of DRAFT version task GUIDs to which the tool needs to be associated.

Response:

  • Returns the newly created AiAgentTool object.

Example Request:

mutation CreateAiAgentTool {
    aiAgentToolCreate(input: {
        providerAccountId: "77196b85-9d08-4ee7-981f-65b45c11fd8b",
        toolType: CUSTOM,
        name: "Customer Data Analyzer",
        description: "Advanced tool for analyzing customer data and generating insights for AI agents.",
        toolJson: "{ \"actionGroupName\": \"CustomerDataAnalysis\", \"description\": \"Action group for customer data analysis\", \"actionGroupState\": \"ENABLED\", \"actions\": [{ \"name\": \"analyzeCustomerData\", \"description\": \"Analyzes customer data for patterns\", \"parameters\": { \"customerId\": { \"type\": \"string\", \"required\": true }, \"analysisType\": { \"type\": \"string\", \"required\": false, \"default\": \"comprehensive\" } } }] }",
        aiAgentTaskIds: ["0701c384-8449-4093-aa2a-3ce89bc44cb0", "3665d6b7-7b4a-4a4d-a181-b6f100b4f0b4"]
        resources: [{
            name: "CustomerDataProcessor",
            description: "Processes and analyzes customer data",
            resourceType: CUSTOM,
            toolResourceJson: "{ \"name\": \"CustomerDataProcessor\", \"description\": \"AWS Lambda function for customer data processing\", \"runtime\": \"nodejs18.x\", \"handler\": \"index.handler\", \"environment\": { \"variables\": { \"ANALYSIS_MODE\": \"advanced\" } }, \"timeout\": 300 }",
        }, {
            name: "DataVisualizationService",
            description: "Creates visualizations from analyzed data",
            resourceType: CUSTOM,
            toolResourceJson: "{ \"name\": \"DataVisualizationService\", \"description\": \"REST API for data visualization\", \"baseUrl\": \"https://api.example.com/v1/visualization\", \"endpoints\": [{ \"path\": \"/charts\", \"method\": \"POST\", \"description\": \"Generate charts from data\" }] }",
        }],
        tags: [
            {
                key: "category"
                value: "analytics"
            },
            {
                key: "dataType"
                value: "customer"
            },
            {
                key: "environment"
                value: "production"
            }
        ]
    }) {
        id
        externalId
        version
        name
        description
        provider
        toolType
        toolJson
        status
        resources {
            name
            description
            resourceType
            toolResourceJson
            status
            externalId
        }
        tags {
            id
            key
            value
        }
        agentVersions {
            id
            externalId
            version
            name
            description
            region
            purpose
            personalityTraitsJson
            instructions
            agentStatus
            versionMetadata
        }
        tasks {
            id
            externalId
            version
            name
            description
            taskStatus
            metaData
            instructions
            syncData {
                lastSyncStatus
                lastSyncStartDate
                lastSyncEndDate
            }
            auditData {
                createdByUserId
                createdTime
                modifiedByUserId
                modifiedTime
                updatedByOrigin
                updatedAtProviderTime
            }
        }
        syncData {
            lastSyncStatus
            lastSyncStartDate
            lastSyncEndDate
        }
        auditData {
            createdByUserId
            createdTime
            modifiedByUserId
            modifiedTime
            updatedByOrigin
            updatedAtProviderTime
        }
    }
}

Example Response (success):


{
    "data": {
        "aiAgentToolCreate": {
            "id": "29e2541b-ff58-41f7-9334-de2c3ea04b70",
            "externalId": null,
            "version": "DRAFT",
            "name": "Customer Data Analyzer",
            "description": "Advanced tool for analyzing customer data and generating insights for AI agents.",
            "provider": "CUSTOM",
            "toolType": "CUSTOM",
            "toolJson": "{ \"actionGroupName\": \"CustomerDataAnalysis\", \"actionGroupState\": \"ENABLED\" }",
            "status": "ENABLED",
            "resources": [
                { "name": "CustomerDataProcessor", "description": "Processes and analyzes customer data", "resourceType": "CUSTOM", "toolResourceJson": "{ \"name\": \"CustomerDataProcessor\" }", "status": "ENABLED", "externalId": null },
                { "name": "DataVisualizationService", "description": "Creates visualizations from analyzed data", "resourceType": "CUSTOM", "toolResourceJson": "{ \"name\": \"DataVisualizationService\" }", "status": "ENABLED", "externalId": null }
            ],
            "tags": [
                { "id": "6f9fe561-2381-488a-92ca-0b79f1c52316", "key": "category", "value": "analytics" },
                { "id": "bf5212f8-10fd-440e-9e95-98d758b0255e", "key": "dataType", "value": "customer" },
                { "id": "46502c8f-92ef-4565-919b-307a06e5af28", "key": "environment", "value": "production" }
            ],
            "agentVersions": [],
            "tasks": [
                { "id": "0701c384-8449-4093-aa2a-3ce89bc44cb0", "externalId": null, "version": "DRAFT", "name": "Data Processing Task", "description": "Task for processing data inputs for AI agents.", "taskStatus": "ACTIVE", "metaData": null, "instructions": [], "syncData": null, "auditData": { "createdByUserId": "617b34c7-d14f-4a7b-a0fe-9047031618c5", "createdTime": "2026-09-17T10:00:00Z", "modifiedByUserId": "617b34c7-d14f-4a7b-a0fe-9047031618c5", "modifiedTime": "2026-09-17T10:00:00Z", "updatedByOrigin": "REGISTRY", "updatedAtProviderTime": null } }
            ],
            "syncData": null,
            "auditData": {
                "createdByUserId": "617b34c7-d14f-4a7b-a0fe-9047031618c5",
                "createdTime": "2026-09-17T10:00:00Z",
                "modifiedByUserId": "617b34c7-d14f-4a7b-a0fe-9047031618c5",
                "modifiedTime": "2026-09-17T10:00:00Z",
                "updatedByOrigin": "REGISTRY",
                "updatedAtProviderTime": null
            }
        }
    }
}

aiAgentToolCreate(
  input: AiAgentToolCreateInput!
): AiAgentTool

Arguments​

aiAgentToolCreate.input ● AiAgentToolCreateInput! non-null input agent-control-tower {#input}

Type​

AiAgentTool object agent-control-tower

Represents an AI Agent Tool in the AI Agent Registry.

On this Page