SIsigmamind
Agents

List Agent Tools

Changed on

Retrieve a paginated list of all the tools associated with the agent.

get/v1/agents/{agentId}/tools

Request

  • Base URL
    https://api.sigmamind.ai
  • Auth
    API key in header X-API-Key

Path parameters

agentIdstring required

Unique identifier of the agent to be retrieved.

Query parameters

pageinteger

Zero-based page number to retrieve. Use 0 for the first page. Must be 0 or greater.

sizeinteger

Number of single prompt agents to return per page. Must be 1 or greater. Defaults to 10.

Response

OK

pageinteger

Current page number (0-based index). Indicates which page of results is being returned.

sizeinteger

Number of items requested per page. Determines the maximum size of the 'data' list.

totalCountinteger

Total number of records available across all pages. Useful for calculating pagination on the client side.

totalPagesinteger

Total number of pages available based on totalCounts and size. Helps clients understand how many pages exist in total.

hasNextboolean

Indicates whether there is a next page available after the current one. Useful for implementing 'Load More' or next navigation.

hasPreviousboolean

Indicates whether there is a previous page before the current one. Useful for enabling backward navigation.

Example response

{
  "data": [
    {
      "integrationId": "intg_AuUKK371Spr5",
      "toolId": "tool_X9pLm2Wq8Rt3",
      "toolName": "Get Order",
      "toolAlias": "get_order",
      "method": "GET",
      "endpoint": "https://my-store.myshopify.com/admin/api/2024-01/orders/{{orderId}}.json",
      "headers": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "params": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "bodyParams": {
        "customer_name": "Michael",
        "account_id": "ACC-001"
      },
      "bodyParamsType": "JSON",
      "statusCode": 200
    }
  ],
  "size": 20,
  "totalCount": 125,
  "totalPages": 7,
  "hasNext": true
}

Changes