OptimisationRuns

List optimisation runs

GET

https://api.gosmarter.ai

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

Lists optimisation runs for the specified company, most recent first, paged.

List optimisation runs › path Parameters

companyId

string · uuid · required

The company GUID.

List optimisation runs › 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 › 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 › 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

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",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Start an optimisation run

POST

https://api.gosmarter.ai

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

Composes a problem payload from the supplied filters, uploads it as a claim-check blob, and dispatches it to the optimisation solver.

Start an optimisation run › path Parameters

companyId

string · uuid · required

The company GUID.

Start an optimisation run › 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 › Request Body

createOptimisationRunRequest

name

string

filterProfileId

string · uuid

optimisationRunFilters

optimisationSettings

Start an optimisation run › Responses

Payload of CreateOptimisationRunResponse

createOptimisationRunResponse

runId

string · uuid

groupCount

integer · int32

unmatchedDemandCount

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
    }
  }
}'

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
    }
  }
}

json

Example Responses

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

json

application/json

Get an optimisation run

GET

https://api.gosmarter.ai

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

Retrieves a single optimisation run — the polling target while a run is pending.

Get an optimisation run › path Parameters

companyId

string · uuid · required

The company GUID.

runId

string · uuid · required

The optimisation run GUID.

Get an optimisation run › 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 › 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

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",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Cancel an optimisation run

POST

https://api.gosmarter.ai

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

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 › path Parameters

companyId

string · uuid · required

The company GUID.

runId

string · uuid · required

The optimisation run GUID.

Cancel an optimisation run › 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 › Responses

No description

No data returned

ProductionPlanBars OptimisationSlim

GoSmarter API Gateway

OptimisationRuns

List optimisation runs

GET

https://api.gosmarter.ai

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

Lists optimisation runs for the specified company, most recent first, paged.

List optimisation runs › path Parameters

companyId

string · uuid · required

The company GUID.

List optimisation runs › 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 › 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 › 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

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",
    "createdAt": "2024-08-25T15:00:00Z",
    "updatedAt": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Start an optimisation run

POST

https://api.gosmarter.ai

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

Composes a problem payload from the supplied filters, uploads it as a claim-check blob, and dispatches it to the optimisation solver.

Start an optimisation run › path Parameters

companyId

string · uuid · required

The company GUID.

Start an optimisation run › 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 › Request Body

createOptimisationRunRequest

name

string

filterProfileId

string · uuid

optimisationRunFilters

optimisationSettings

Start an optimisation run › Responses

Payload of CreateOptimisationRunResponse

createOptimisationRunResponse

runId

string · uuid

groupCount

integer · int32

unmatchedDemandCount

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
    }
  }
}'

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
    }
  }
}

json

Example Responses

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

json

application/json

Get an optimisation run

GET

https://api.gosmarter.ai

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

Retrieves a single optimisation run — the polling target while a run is pending.

Get an optimisation run › path Parameters

companyId

string · uuid · required

The company GUID.

runId

string · uuid · required

The optimisation run GUID.

Get an optimisation run › 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 › 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

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",
  "createdAt": "2024-08-25T15:00:00Z",
  "updatedAt": "2024-08-25T15:00:00Z"
}

json

application/json

Cancel an optimisation run

POST

https://api.gosmarter.ai

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

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 › path Parameters

companyId

string · uuid · required

The company GUID.

runId

string · uuid · required

The optimisation run GUID.

Cancel an optimisation run › 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 › Responses

No description

No data returned

ProductionPlanBars OptimisationSlim