v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

AI Configs

Update AI tool

Edit an existing AI tool.

patch/api/v2/projects/{projectKey}/ai-tools/{toolKey}

Path parameters

projectKeystring required

toolKeystring required

Request body

maintainerIdstring

maintainerTeamKeystring

descriptionstring

schemaobject

JSON Schema defining the tool's parameters for LLM consumption

customParametersobject

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

Example request

{
  "schema": "{}",
  "maintainerId": "507f1f77bcf86cd799439011",
  "maintainerTeamKey": "example-team-key",
  "description": "description",
  "customParameters": "{}"
}

Response

AI tool updated

keystring required

descriptionstring

schemaobject required

JSON Schema defining the tool's parameters for LLM consumption

customParametersobject

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

versioninteger required

createdAtinteger required

Example response

{
  "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"
    }
  },
  "description": "description",
  "customParameters": "{}",
  "version": 0,
  "key": "key"
}