Planning endpoint

Create Planning Session

Send this request to the AkôFlow daemon. Authentication is required when an API token is configured.

POST/planning-sessions/

Body

application/json

id string

Field defined by domain.PlanningSession.

workflowVersionId string

Field defined by domain.PlanningSession.

executionScopeId string

Field defined by domain.PlanningSession.

networkTopologyId string

Field defined by domain.PlanningSession.

status string

Field defined by domain.PlanningSession.

algorithms array

Field defined by domain.PlanningSession.

progress number

Field defined by domain.PlanningSession.

candidateCount number

Field defined by domain.PlanningSession.

selectedCandidateId string

Field defined by domain.PlanningSession.

selectedPlanId string

Field defined by domain.PlanningSession.

deadlineSeconds number

Field defined by domain.PlanningSession.

budget number

Field defined by domain.PlanningSession.

configuration object

Field defined by domain.PlanningSession.

failureReason string

Field defined by domain.PlanningSession.

createdAt string

Field defined by domain.PlanningSession.

startedAt string

Field defined by domain.PlanningSession.

completedAt string

Field defined by domain.PlanningSession.

cURL

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/"

202 Acceptedapplication/json

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

*domain.PlanningSession

Related guide

See the Planning guide for the corresponding Desktop workflow, concepts, and authored request examples.

Generated from the daemon router

This page is generated from internal/api/httpserver/httpserver.go, the registered handler, and JSON-tagged Go structs. Method, path, request fields, response kind, query parameters, media type, and successful status codes stay synchronized with the implementation.