Async Jobs

Submit an async simulation job

Submit a large simulation to run asynchronously. Returns a job_id immediately. Poll /v1/jobs/{job_id} for status. Provide a callback_url to receive a webhook when complete.

post/v1/jobs

Request

  • Base URL: https://api.algenta.ai
  • URL: https://api.algenta.ai/v1/jobs
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

callback_urlstring nullable

URL to POST when the job completes. Must be HTTPS in production.

Example request

{
  "request": {
    "mode": "auto",
    "runs": 10000,
    "scenario": {
      "name": "Product launch decision",
      "objective": "maximize_net_value",
      "variables": {
        "cost": {
          "high": 90000,
          "low": 40000
        },
        "revenue": {
          "high": 200000,
          "low": 80000
        }
      }
    },
    "simulation_model": "monte_carlo"
  }
}

Response

Successful Response

job_idstring uuid required
run_idstring uuid required
statusstring required
poll_urlstring required
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.