Planning endpoint

Create Planning Session

POST/planning-sessions/

Example request

application/json

{
  "id": "planning-simulation-example",
  "workflowVersionId": "simulation-example-workflow-v1",
  "executionScopeId": "simulation-example-v1-scope",
  "networkTopologyId": "simulation-network-v1",
  "algorithms": [
    {
      "id": "heft",
      "configuration": {}
    }
  ]
}

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  -X POST \
  "${AKOFLOW_API_URL}/planning-sessions/"

Supply a valid request.json before running this command.

202 Acceptedapplication/json

Field shape inferred from Go types; inspect the returned JSON for actual values and optional fields.

{
  "id": "string",
  "workflowVersionId": "string",
  "executionScopeId": "string",
  "networkTopologyId": "string",
  "status": "string",
  "algorithms": [
    {
      "id": "string",
      "configuration": {}
    }
  ],
  "progress": 0,
  "candidateCount": 0,
  "selectedCandidateId": "string",
  "selectedPlanId": "string",
  "deadlineSeconds": 0,
  "budget": 0,
  "configuration": {},
  "failureReason": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "startedAt": "2026-01-01T00:00:00Z",
  "completedAt": "2026-01-01T00:00:00Z"
}

Handler-checked behavior

Required: id, an existing workflowVersionId, executionScopeId, and networkTopologyId, plus at least one algorithms entry. Each algorithm ID must appear in GET /planning-algorithms/; duplicate IDs are rejected. The server sets status and timestamps. The example IDs require the SimGrid environment, scope, topology, and workflow to be registered first.

Related guide

See the Planning guide for related tasks and context.