Agent Control

Create an AI tool

POST
/api/v2/projects/{projectKey}/ai-tools

Create an AI tool

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

projectKey*string

Request Body

application/json

AI tool object to create

key*string
maintainerId?string
maintainerTeamKey?string
description?string
schema*

JSON Schema defining the tool's parameters for LLM consumption

customParameters?

Custom metadata and configuration for application-level use (not sent to LLM)

tags?array<string>

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/projects/string/ai-tools" \  -H "Content-Type: application/json" \  -d '{    "schema": "{}",    "maintainerId": "507f1f77bcf86cd799439011",    "maintainerTeamKey": "example-team-key",    "description": "description",    "customParameters": "{}",    "key": "key",    "tags": [      "tags",      "tags"    ]  }'
{  "schema": "{}",  "createdAt": 6,  "_maintainer": {    "kind": "kind"  },  "_access": {    "allowed": [      {        "reason": {          "role_name": "role_name",          "notActions": [            null,            null          ],          "notResources": [            "notResources",            "notResources"          ],          "effect": "allow",          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "actions": [            "*"          ]        },        "action": "action"      },      {        "reason": {          "role_name": "role_name",          "notActions": [            null,            null          ],          "notResources": [            "notResources",            "notResources"          ],          "effect": "allow",          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "actions": [            "*"          ]        },        "action": "action"      }    ],    "denied": [      {        "reason": {          "role_name": "role_name",          "notActions": [            null,            null          ],          "notResources": [            "notResources",            "notResources"          ],          "effect": "allow",          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "actions": [            "*"          ]        },        "action": "action"      },      {        "reason": {          "role_name": "role_name",          "notActions": [            null,            null          ],          "notResources": [            "notResources",            "notResources"          ],          "effect": "allow",          "resources": [            "proj/*:env/*;qa_*:/flag/*"          ],          "actions": [            "*"          ]        },        "action": "action"      }    ]  },  "_links": {    "parent": {      "href": "href",      "type": "type"    },    "self": {      "href": "href",      "type": "type"    }  },  "_site": {    "href": "href",    "type": "type"  },  "description": "description",  "customParameters": "{}",  "version": 0,  "key": "key",  "tags": [    "tags",    "tags"  ]}