OptimisationRuns

List optimisation runs (Preview)

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/runs

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Lists optimisation runs for the specified company, most recent first, paged.

List optimisation runs (Preview) › path Parameters

companyId

string · uuid · required

The company GUID.

List optimisation runs (Preview) › query Parameters

offset

integer · int32

Zero-based row offset for pagination. Example: 0

limit

integer · int32

Maximum number of rows to return (capped at 200). Example: 50

List optimisation runs (Preview) › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

List optimisation runs (Preview) › Responses

Payload of Array of OptimisationRunDto

optimisationRunDto[]

optimisationRunDto

runId

string · uuid

companyId

string · uuid

status

integer · int32

filterProfileId

string · uuid

problemBlobUri

string

resultBlobUri

string

errorMessage

string

groupCount

integer · int32

requestedBy

string · uuid

planId

string · uuid

runName

string

createdAt

string · date-time

updatedAt

string · date-time

GET/api/company/{companyId}/optimisation/runs

curl https://api.gosmarter.ai/api/company/:companyId/optimisation/runs \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "runId": "00000000-0000-0000-0000-000000000000",
    "companyId": "00000000-0000-0000-0000-000000000000",
    "status": 0,
    "filterProfileId": "00000000-0000-0000-0000-000000000000",
    "problemBlobUri": "problemBlobUri",
    "resultBlobUri": "resultBlobUri",
    "errorMessage": "errorMessage",
    "groupCount": 0,
    "requestedBy": "00000000-0000-0000-0000-000000000000",
    "planId": "00000000-0000-0000-0000-000000000000",
    "runName": "runName",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Start an optimisation run (Preview)

POST

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/runs

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Uploads a problem payload as a claim-check blob and dispatches it to the optimisation solver. With PreviewId, dispatches exactly that preview's saved snapshot (Filters/SolverSettings are recorded but not re-applied); otherwise composes a fresh problem from the supplied filters.

Start an optimisation run (Preview) › path Parameters

companyId

string · uuid · required

The company GUID.

Start an optimisation run (Preview) › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Start an optimisation run (Preview) › Request Body

createOptimisationRunRequest

name

string

filterProfileId

string · uuid

optimisationRunFilters

optimisationSettings

excludedGroupKeys

string[]

previewId

string · uuid

Start an optimisation run (Preview) › Responses

Payload of CreateOptimisationRunResponse

createOptimisationRunResponse

runId

string · uuid

groupCount

integer · int32

unmatchedDemandCount

integer · int32

excludedGroupCount

integer · int32

POST/api/company/{companyId}/optimisation/runs

curl https://api.gosmarter.ai/api/company/:companyId/optimisation/runs \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "filterProfileId": "00000000-0000-0000-0000-000000000000",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0,
      "tagPreference": 0,
      "ungradedDemandAllocation": "ungradedDemandAllocation"
    },
    "randomSeed": 0
  },
  "excludedGroupKeys": [
    "string"
  ],
  "previewId": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "name": "name",
  "filterProfileId": "00000000-0000-0000-0000-000000000000",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0,
      "tagPreference": 0,
      "ungradedDemandAllocation": "ungradedDemandAllocation"
    },
    "randomSeed": 0
  },
  "excludedGroupKeys": [
    "string"
  ],
  "previewId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "runId": "00000000-0000-0000-0000-000000000000",
  "groupCount": 0,
  "unmatchedDemandCount": 0,
  "excludedGroupCount": 0
}

json

application/json

Preview an optimisation run (Preview)

POST

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/runs/preview

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Composes the problem an optimisation run would dispatch for the supplied filters, saves it as a short-lived preview snapshot, and returns a per-group summary with per-order detail plus the snapshot's PreviewId. Nothing is persisted to the database or dispatched; pass PreviewId to StartOptimisationRun (within 30 minutes) to dispatch exactly this composition. ExcludedGroupKeys is ignored — every composed group is returned.

Preview an optimisation run (Preview) › path Parameters

companyId

string · uuid · required

The company GUID.

Preview an optimisation run (Preview) › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Preview an optimisation run (Preview) › Request Body

createOptimisationRunRequest

name

string

filterProfileId

string · uuid

optimisationRunFilters

optimisationSettings

excludedGroupKeys

string[]

previewId

string · uuid

Preview an optimisation run (Preview) › Responses

Payload of OptimisationRunPreview

optimisationRunPreview

previewId

string · uuid

composedAt

string · date-time

optimisationRunPreviewGroup[]

totalGroups

integer · int32

totalStockBarCount

integer · int32

totalDemandPieceCount

integer · int32

previewExclusionSummary

POST/api/company/{companyId}/optimisation/runs/preview

curl https://api.gosmarter.ai/api/company/:companyId/optimisation/runs/preview \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "filterProfileId": "00000000-0000-0000-0000-000000000000",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0,
      "tagPreference": 0,
      "ungradedDemandAllocation": "ungradedDemandAllocation"
    },
    "randomSeed": 0
  },
  "excludedGroupKeys": [
    "string"
  ],
  "previewId": "00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "name": "name",
  "filterProfileId": "00000000-0000-0000-0000-000000000000",
  "filters": {
    "inventory": {
      "typeIds": [
        0
      ],
      "materialIds": [
        0
      ],
      "stockLocationIds": [
        0
      ],
      "supplierIds": [
        "00000000-0000-0000-0000-000000000000"
      ],
      "minDiameterMm": 0,
      "maxDiameterMm": 0
    },
    "orders": {
      "statuses": [
        "string"
      ],
      "deliveryFrom": "2024-08-25T15:00:00Z",
      "deliveryTo": "2024-08-25T15:00:00Z",
      "orderReferences": [
        "string"
      ],
      "tagIds": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  },
  "solverSettings": {
    "algorithm": "algorithm",
    "populationSize": 0,
    "maxIterations": 0,
    "timeLimitSeconds": 0,
    "offcutThresholdMm": {
      "default": 0,
      "byDiameterMaxMm": [
        {
          "maxDiameterMm": 0,
          "thresholdMm": 0
        }
      ]
    },
    "kerfMm": 0,
    "priorities": {
      "orderUrgency": "orderUrgency",
      "stockConsumption": "stockConsumption",
      "wasteVsSimplicity": 0,
      "certQuality": 0,
      "tagPreference": 0,
      "ungradedDemandAllocation": "ungradedDemandAllocation"
    },
    "randomSeed": 0
  },
  "excludedGroupKeys": [
    "string"
  ],
  "previewId": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "previewId": "00000000-0000-0000-0000-000000000000",
  "composedAt": "2024-08-25T15:00:00Z",
  "groups": [
    {
      "groupKey": "groupKey",
      "attributes": {
        "productType": "productType",
        "material": "material",
        "diameterMm": 0,
        "wallThicknessMm": 0,
        "widthMm": 0,
        "depthMm": 0,
        "sectionDesignation": "sectionDesignation",
        "nominalSize": "nominalSize",
        "grade": "grade"
      },
      "stockLineCount": 0,
      "stockBarCount": 0,
      "stockLengthM": 0,
      "demandLineCount": 0,
      "demandPieceCount": 0,
      "demandLengthM": 0,
      "orderCount": 0,
      "ungradedLineCount": 0,
      "orders": [
        {
          "orderId": "00000000-0000-0000-0000-000000000000",
          "orderReference": "orderReference",
          "customerName": "customerName",
          "customerPurchaseOrderReference": "customerPurchaseOrderReference",
          "deliveryDate": "2024-08-25T15:00:00Z",
          "priority": 0,
          "status": "status",
          "lineItems": [
            {
              "orderLineItemId": "00000000-0000-0000-0000-000000000000",
              "lengthMm": 0,
              "quantity": 0,
              "totalLengthM": 0,
              "gradeAllocation": "gradeAllocation",
              "gradeAllocationRank": 0
            }
          ]
        }
      ]
    }
  ],
  "totalGroups": 0,
  "totalStockBarCount": 0,
  "totalDemandPieceCount": 0,
  "unmatchedDemand": {
    "total": 0,
    "byReason": {
      "key": 0
    }
  },
  "unusedStock": {
    "total": 0,
    "byReason": {
      "key": 0
    }
  }
}

json

application/json

Get an optimisation run (Preview)

GET

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/runs/{runId}

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Retrieves a single optimisation run — the polling target while a run is pending.

Get an optimisation run (Preview) › path Parameters

companyId

string · uuid · required

The company GUID.

runId

string · uuid · required

The optimisation run GUID.

Get an optimisation run (Preview) › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Get an optimisation run (Preview) › Responses

Payload of OptimisationRunDto

optimisationRunDto

runId

string · uuid

companyId

string · uuid

status

integer · int32

filterProfileId

string · uuid

problemBlobUri

string

resultBlobUri

string

errorMessage

string

groupCount

integer · int32

requestedBy

string · uuid

planId

string · uuid

runName

string

createdAt

string · date-time

updatedAt

string · date-time

GET/api/company/{companyId}/optimisation/runs/{runId}

curl https://api.gosmarter.ai/api/company/:companyId/optimisation/runs/:runId \
  --header 'GoSmarter-Api-Key: <string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "runId": "00000000-0000-0000-0000-000000000000",
  "companyId": "00000000-0000-0000-0000-000000000000",
  "status": 0,
  "filterProfileId": "00000000-0000-0000-0000-000000000000",
  "problemBlobUri": "problemBlobUri",
  "resultBlobUri": "resultBlobUri",
  "errorMessage": "errorMessage",
  "groupCount": 0,
  "requestedBy": "00000000-0000-0000-0000-000000000000",
  "planId": "00000000-0000-0000-0000-000000000000",
  "runName": "runName",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Cancel an optimisation run (Preview)

POST

https://api.gosmarter.ai

/api/company/{companyId}/optimisation/runs/{runId}/cancel

Preview: this operation may change or be removed without a new versioned route or notice period until it is announced as stable (see the API Versioning Policy). Marks a run as cancelled. Rejected with 400 if the run has already reached a terminal or later status (ResultReceived/SolveFailed/Failed/PlanCreated).

Cancel an optimisation run (Preview) › path Parameters

companyId

string · uuid · required

The company GUID.

runId

string · uuid · required

The optimisation run GUID.

Cancel an optimisation run (Preview) › Headers

GoSmarter-Api-Key

string · required

The GoSmarter-Api-Key header is used to authenticate with the API using your API key. Value is of the format YOUR_KEY_HERE.

Cancel an optimisation run (Preview) › Responses

No description

No data returned

ProductionPlanBars OptimisationSlim