Upload value model

PUT

https://api.agentpaid.io/api/v2/value-models/

PUT

/api/v2/value-models/

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.valueModels.updateValueModel({
        content: {
            currency: "string",
            valueTypes: [
                {
                    slug: "string",
                    name: "string",
                    calculationTimeline: [
                        {
                            effectiveFrom: new Date("2024-01-15T09:30:00Z"),
                            calculation: {
                                unit: {
                                    type: "monetary",
                                },
                                formulaIds: [
                                    "string",
                                ],
                                signalEventNames: [
                                    "string",
                                ],
                                segmentTableIds: [
                                    "string",
                                ],
                                overrideIds: [
                                    "string",
                                ],
                            },
                        },
                    ],
                },
            ],
            formulas: [
                {
                    id: "string",
                    valueTypeSlug: "string",
                    label: "string",
                    variables: [
                        {
                            id: "string",
                            label: "string",
                        },
                    ],
                    expression: "string",
                },
            ],
            signals: [
                {
                    eventName: "string",
                    label: "string",
                },
            ],
        },
    });
}
main();

{
  "id": "string",
  "version": 3,
  "content": {
    "currency": "string",
    "valueTypes": [
      {
        "slug": "string",
        "name": "string",
        "calculationTimeline": [
          {
            "effectiveFrom": "2024-01-15T09:30:00Z",
            "calculation": {
              "unit": {
                "type": "monetary"
              },
              "formulaIds": [
                "string"
              ],
              "signalEventNames": [
                "string"
              ],
              "segmentTableIds": [
                "string"
              ],
              "overrideIds": [
                "string"
              ],
              "monetaryConversion": {
                "expression": "string",
                "variables": [
                  {
                    "id": "string",
                    "label": "string",
                    "default": 1.1
                  }
                ],
                "conditions": [
                  {
                    "field": "string",
                    "operator": "gte",
                    "value": 1.1,
                    "result": {
                      "type": "constant",
                      "value": 1.1,
                      "expression": "string"
                    }
                  }
                ]
              }
            }
          }
        ],
        "description": "string",
        "longDescription": "string",
        "sources": [
          {
            "name": "string",
            "url": "string"
          }
        ],
        "maturation": null,
        "displayOrder": 1,
        "color": "string",
        "icon": "string",
        "category": "hve",
        "archivedAt": "2024-01-15T09:30:00Z"
      }
    ],
    "formulas": [
      {
        "id": "string",
        "valueTypeSlug": "string",
        "label": "string",
        "variables": [
          {
            "id": "string",
            "label": "string",
            "type": "number",
            "description": "string",
            "format": "percent",
            "formatUnit": "seconds",
            "derivedFrom": {
              "sourceField": "string",
              "targetUnit": "seconds",
              "sourceUnit": "seconds",
              "sourceUnitFromSignal": true
            }
          }
        ],
        "expression": "string",
        "description": "string",
        "conditions": [
          {
            "field": "string",
            "operator": "gte",
            "value": 1.1,
            "result": {
              "type": "constant",
              "value": 1.1,
              "expression": "string"
            }
          }
        ],
        "defaultResult": {
          "type": "constant",
          "value": 1.1,
          "expression": "string"
        }
      }
    ],
    "signals": [
      {
        "eventName": "string",
        "label": "string",
        "formulaId": "string",
        "variableMapping": {},
        "defaults": {},
        "segmentTableIds": [
          "string"
        ],
        "description": "string",
        "labels": [
          "string"
        ],
        "tags": [
          "string"
        ]
      }
    ],
    "segmentTables": [
      {
        "id": "string",
        "label": "string",
        "segmentKeys": [
          "string"
        ],
        "columns": [
          {
            "variableId": "string",
            "label": "string",
            "type": "number"
          }
        ],
        "rows": [
          {
            "segmentValues": {},
            "variables": {}
          }
        ],
        "defaultRow": {}
      }
    ],
    "overrides": [
      {
        "id": "string",
        "label": "string",
        "scope": {
          "customerIds": [
            "string"
          ],
          "customerGroupIds": [
            "string"
          ]
        },
        "currency": "string",
        "valueTypeOverrides": {},
        "additionalSignals": [
          {
            "eventName": "string",
            "label": "string",
            "formulaId": "string",
            "variableMapping": {},
            "defaults": {},
            "segmentTableIds": [
              "string"
            ],
            "description": "string",
            "labels": [
              "string"
            ],
            "tags": [
              "string"
            ]
          }
        ],
        "monetaryConversionOverrides": {}
      }
    ],
    "groupingKeys": [
      {
        "id": "string",
        "field": "string",
        "displayName": "string"
      }
    ],
    "flows": [
      {
        "id": "string",
        "name": "string",
        "groupingKeyId": "string",
        "value": "string",
        "completionEventName": "string",
        "runNoun": "string",
        "runNameField": "string"
      }
    ],
    "actions": [
      {
        "eventName": "string",
        "name": "string",
        "fields": [
          {
            "key": "string",
            "label": "string",
            "type": "text",
            "description": "string",
            "isTitle": true,
            "hidden": true
          }
        ]
      }
    ]
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "activatedAt": "2024-01-15T09:30:00Z",
  "effectiveFrom": "2024-01-15T09:30:00Z",
  "effectiveTo": "2024-01-15T09:30:00Z"
}

Uploads a new value model version. Validates the content, creates a new version, archives the previous active version, and syncs to ClickHouse. This updates how value is calculated going forward — new signals are valued under the new model. It does NOT re-rate historical signals; run POST /api/v2/value-models/backfill to re-rate history as a separate, explicit action.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

contentobjectRequired

Full value model configuration: value types, formulas, events, overrides, and actions.

effectiveFromdatetimeOptional

effectiveTodatetimeOptional

Response

200

idstringformat: "uuid"

Value model version ID.

versioninteger

Monotonically increasing version number.

contentobject

Full value model configuration: value types, formulas, events, overrides, and actions.

createdAtdatetime

activatedAtdatetime or null

effectiveFromdatetime or null

effectiveTodatetime or null

Errors

400

Bad Request Error

500

Internal Server Error