Workflows endpoint

Import workflow definition

POST/workflow-definitions/import/

Request body

application/json

See the request guidance below for a valid body.

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}/workflow-definitions/import/"

Supply a valid request.json before running this command.

201 Createdapplication/json

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

{
  "id": "string",
  "externalId": "string",
  "name": "string",
  "namespace": "string",
  "version": {
    "id": "string",
    "workflowId": "string",
    "version": 0,
    "definitionHash": "string",
    "activities": [],
    "dependencies": [],
    "dataDependencies": []
  },
  "activityTypes": [
    {
      "id": "string",
      "name": "string",
      "application": "string",
      "defaultImage": "string",
      "cpuIntensity": 0,
      "memoryIntensity": 0,
      "ioIntensity": 0,
      "networkIntensity": 0,
      "metadata": {}
    }
  ]
}

Runnable SimGrid request

Use akoflow-examples/simulation/workflow.yaml instead of the create-workflow request in the first-run tutorial. Keep the other five requests in order so their referenced IDs exist. Do not submit the same workflow through both routes.

Handler-checked behavior

This compatibility route uses the same portable YAML/JSON importer as POST /workflow-definitions/. Supply name, spec.namespace, and activities with valid dependencies and execution or simulation fields. The workflow specification defines the authoring format; a duplicate normalized workflow ID returns 422.

Related guide

See the Workflows guide for related tasks and context.