Execute Tool

Execute a given agent tool.

SecurityBearerAuth or ApiKeyAuth
Request
path Parameters
agent_id
required
string
Example: 1234a123-12a1-12a1-1a1a-1a1abc12abc1
tool_id
required
string
Example: tool_defined_name
Request Body schema: application/json
object
Responses
200

Return results in Dynamic JSON format

400

Bad Request.

401

Unauthorized access.

403

Forbidden.

404

The specified resource was not found

429

Too Many Requests.

500

Internal Server Error.

503

Service Unavailable.

default

Default error

post/api/ai/agents/{agent_id}/tools/{tool_id}
Request samples
application/json
{
  • "kpi": "KIP_DEFINED_NAME",
  • "field_ids": [
    ]
}
Response samples
application/json
{
  • "kpis_and_attributes": [
    ]
}