Skip to main content
POST
/
test_framework
/
v1
/
aiagents
/
{agent_id}
/
tools
cURL
curl --request POST \
  --url https://api.cekura.ai/test_framework/v1/aiagents/{agent_id}/tools/ \
  --header 'Content-Type: application/json' \
  --header 'X-CEKURA-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "information": "<unknown>"
}
'
{
  "name": "tool_user_data",
  "description": "This tool retrieves user data from the database based on user ID",
  "information": [
    {
      "input": {
        "user_id": 1
      },
      "output": {
        "name": "John Doe",
        "age": 30,
        "email": "[email protected]"
      }
    },
    {
      "input": {
        "user_id": 2
      },
      "output": {
        "name": "Jane Smith",
        "age": 25,
        "email": "[email protected]"
      }
    }
  ]
}

Authorizations

​
X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Path Parameters

​
agent_id
string
required

Body

​
name
string

Name of the tool - must be less than 64 characters and contain only alphanumerics, underscores, and hyphens

Maximum string length: 255
​
description
string

Description of the mock tool. Example: "This tool retrieves user data from the database based on user ID"

​
information
any

Information of the tool - must be a list of input-output mappings. Example:

[
    {
        "input": {"user_id": 1},
        "output": {"name": "John Doe", "age": 30, "email": "[email protected]"}
    },
    {
        "input": {"user_id": 2},
        "output": {"name": "Jane Smith", "age": 25, "email": "[email protected]"}
    }
]

Response

201 - application/json
​
id
integer
​
name
string

Name of the tool - must be less than 64 characters and contain only alphanumerics, underscores, and hyphens

Maximum string length: 255
​
description
string

Description of the mock tool. Example: "This tool retrieves user data from the database based on user ID"

​
information
any

Information of the tool - must be a list of input-output mappings. Example:

[
    {
        "input": {"user_id": 1},
        "output": {"name": "John Doe", "age": 30, "email": "[email protected]"}
    },
    {
        "input": {"user_id": 2},
        "output": {"name": "Jane Smith", "age": 25, "email": "[email protected]"}
    }
]