SIsigmamind
Mock Tool Data

Get Mock Tool Data

Changed on

Retrieves a single mock tool data record by mockToolDataId. agentId is optional; when supplied, returns mocks that belong to that agent.

get/v1/mock-tool-data/{mockToolDataId}

Request

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

Path parameters

mockToolDataIdstring required

Unique identifier of the mock tool data record.

Query parameters

agentIdstring

Optional agent identifier. When supplied, returns mocks that belong to the agent.

Response

OK

mockToolDataIdstring

Public identifier of the mock tool data record.

namestring

Human-readable name for this mock.

agentIdstring

The unique identifier of the agent this mock belongs to.

toolIdstring

Public identifier of the integration tool this mock belongs to.

toolAliasstring

Agent tool alias this mock was created against.

toolNamestring

Display name of the tool at the time the mock was created.

requestobject

Request payload (or placeholders) associated with this mock.

responseobject

Mocked HTTP response body.

statusCodeinteger

HTTP status code returned when this mock is used.

delayinteger

Artificial delay in milliseconds before returning the mock response.

Example response

{
  "mockToolDataId": "mock_dpKjqjKnY3z6gABF",
  "name": "Success - Order Confirmed",
  "agentId": "agent_D5D0p7TUs66TTAEAx",
  "toolId": "tool_X9pLm2Wq8Rt3",
  "toolAlias": "get_order",
  "toolName": "Get Order",
  "request": {
    "order_id": "1073460023"
  },
  "response": {
    "order": {
      "id": 1073460023,
      "confirmation_number": "A50GQT45C",
      "confirmed": true,
      "created_at": "2026-07-01T12:34:26-04:00",
      "currency": "EUR",
      "current_subtotal_price": "224.97",
      "current_subtotal_price_set": {
        "shop_money": {
          "amount": "224.97",
          "currency_code": "EUR"
        },
        "presentment_money": {
          "amount": "224.97",
          "currency_code": "EUR"
        }
      }
    }
  },
  "statusCode": 200,
  "delay": 500
}

Changes