Planning endpoint

Retrieve Planning Session

GET/planning-sessions/{sessionId}/

Path parameters

sessionId

Identifier used by the registered route.

Request body

none

This endpoint does not accept a request body.

cURL template

curl --fail-with-body \
  -H "Authorization: Bearer ${AKOFLOW_API_TOKEN}" \
  "${AKOFLOW_API_URL}/planning-sessions/{sessionId}/"

Replace the path identifiers with IDs from your instance.

200 OKapplication/json

Handler-checked response shape; values and optional fields vary.

{
  "session": {
    "id": "session-id",
    "workflowVersionId": "workflow-version-id",
    "executionScopeId": "scope-id",
    "networkTopologyId": "topology-id",
    "status": "completed",
    "algorithms": [
      {
        "id": "heft"
      }
    ],
    "progress": 1,
    "candidateCount": 1,
    "createdAt": "2026-01-01T00:00:00Z"
  },
  "algorithmRuns": [
    {
      "id": "algorithm-run-id",
      "planningSessionId": "session-id",
      "algorithm": "heft",
      "objective": "time",
      "status": "completed",
      "progress": 1,
      "candidateCount": 1,
      "estimate": {
        "durationSeconds": 0.1,
        "expandedStates": 1,
        "activityCount": 1,
        "dependencyCount": 0,
        "compatibleResources": 1,
        "confidence": "calibrated"
      }
    }
  ]
}

Response shape

The response pairs the saved session with its algorithm runs. selectedCandidateId and selectedPlanId appear only after selection; a completed session may have neither. The estimate describes predicted planning work, not execution time.

Related guide

See the Planning guide for related tasks and context.