Skip to main content
GET
/
v2
/
ai-agents
/
{ai_agent_id}
/
custom-tools
List custom tools
curl --request GET \
  --url https://api.example.com/v2/ai-agents/{ai_agent_id}/custom-tools/
{
  "tools": [
    {
      "openai_tool": {
        "name": "<string>",
        "description": "<string>",
        "parameters": {
          "properties": {},
          "type": "object",
          "required": [
            "<string>"
          ],
          "additionalProperties": false
        }
      },
      "additional_tool_info": {
        "api": {
          "endpoint": "https://api.example.com/test",
          "headers": {
            "Content-Type": "application/json"
          },
          "method": "POST",
          "parameters": {
            "fixed_params": {
              "api_key": {
                "description": "API key for authentication",
                "value": "test-api-key"
              }
            },
            "runtime_params": {}
          }
        },
        "tool_type": "custom"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "tool_id": "<string>",
      "tool_start_message": "<string>",
      "tool_delayed_message": "<string>",
      "tool_complete_message": "<string>",
      "tool_failed_message": "<string>"
    }
  ],
  "next_page_token": "<string>"
}

Path Parameters

​
ai_agent_id
string
required

Query Parameters

​
page_size
integer
default:20
Required range: 1 <= x <= 100
​
page_token
string | null

Response

Successful Response

​
tools
PiaCustomToolResponse · object[]

List of custom tools matching the request criteria

​
next_page_token
string | null

Token to retrieve the next page of results, null if no more results available