SIsigmamind
Mock Tool Data

Create Mock Tool Data

Changed on

Creates a named mock tool data in the tenant mock library. Use this for manual mock tool data creation or after capturing a live tool execute. Returns the created mock including its mockToolDataId.

post/v1/mock-tool-data

Request

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

Request body

namestring required

Human-readable name for this mock, used when picking mocks in the test-case UI.

agentIdstring required

The unique identifier of the agent this mock belongs to.

toolIdstring

Identifier of the integration tool this mock belongs to. Optional when toolAlias can uniquely resolve the tool.

requestobject

Optional request payload (or placeholders) associated with this mock, for documentation and capture.

responseobject required

Mocked HTTP response body returned when this mock is used during simulation.

statusCode100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511 required

HTTP status code to return when this mock is used.

delayinteger

Artificial delay in milliseconds before returning the mock response. Defaults to 0.

toolAliasstring required

Agent tool alias this mock is bound to.

Example request

{
  "name": "Success - Order Confirmed",
  "agentId": "agent_D5D0p7TUs66TTAEAx",
  "toolId": "tool_X9pLm2Wq8Rt3",
  "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,
  "toolAlias": "get_order"
}

Response

Created

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