Skip to main content
POST
/
workflows
/
versions
Python SDK
from cognite.client.data_classes import (
    WorkflowVersionUpsert, WorkflowDefinitionUpsert,
    WorkflowTask, FunctionTaskParameters,
)
function_task = WorkflowTask(
    external_id="my_workflow-task1",
    parameters=FunctionTaskParameters(
        external_id="my_fn_xid",
        data={"a": 1, "b": 2},
    ),
)
new_version = WorkflowVersionUpsert(
   workflow_external_id="my_workflow",
   version="1",
   workflow_definition=WorkflowDefinitionUpsert(
       tasks=[function_task],
       description="This workflow has one step",
   ),
)
res = client.workflows.versions.upsert(new_version)
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "workflowExternalId": "<string>",
      "version": "<string>",
      "workflowDefinition": {
        "tasks": [
          {
            "externalId": "<string>",
            "parameters": {
              "isAsyncComplete": false
            },
            "name": "<string>",
            "description": "<string>",
            "retries": 3,
            "timeout": 3600,
            "onFailure": "abortWorkflow",
            "dependsOn": [
              {
                "externalId": "my.known.id"
              }
            ],
            "lineageAnnotation": {
              "sources": [
                {
                  "uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
                }
              ],
              "targets": [
                {
                  "uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
                }
              ]
            }
          }
        ],
        "description": "<string>"
      }
    }
  ]
}
'
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    items: [
      {
        workflowExternalId: '<string>',
        version: '<string>',
        workflowDefinition: {
          tasks: [
            {
              externalId: '<string>',
              parameters: {isAsyncComplete: false},
              name: '<string>',
              description: '<string>',
              retries: 3,
              timeout: 3600,
              onFailure: 'abortWorkflow',
              dependsOn: [{externalId: 'my.known.id'}],
              lineageAnnotation: {
                sources: [{uri: 'cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings'}],
                targets: [{uri: 'cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings'}]
              }
            }
          ],
          description: '<string>'
        }
      }
    ]
  })
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'items' => [
        [
                'workflowExternalId' => '<string>',
                'version' => '<string>',
                'workflowDefinition' => [
                                'tasks' => [
                                                                [
                                                                                                                                'externalId' => '<string>',
                                                                                                                                'parameters' => [
                                                                                                                                                                                                                                                                'isAsyncComplete' => false
                                                                                                                                ],
                                                                                                                                'name' => '<string>',
                                                                                                                                'description' => '<string>',
                                                                                                                                'retries' => 3,
                                                                                                                                'timeout' => 3600,
                                                                                                                                'onFailure' => 'abortWorkflow',
                                                                                                                                'dependsOn' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'externalId' => 'my.known.id'
                                                                                                                                                                                                                                                                ]
                                                                                                                                ],
                                                                                                                                'lineageAnnotation' => [
                                                                                                                                                                                                                                                                'sources' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'uri' => 'cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                ],
                                                                                                                                                                                                                                                                'targets' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'uri' => 'cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ],
                                'description' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions"

	payload := strings.NewReader("{\n  \"items\": [\n    {\n      \"workflowExternalId\": \"<string>\",\n      \"version\": \"<string>\",\n      \"workflowDefinition\": {\n        \"tasks\": [\n          {\n            \"externalId\": \"<string>\",\n            \"parameters\": {\n              \"isAsyncComplete\": false\n            },\n            \"name\": \"<string>\",\n            \"description\": \"<string>\",\n            \"retries\": 3,\n            \"timeout\": 3600,\n            \"onFailure\": \"abortWorkflow\",\n            \"dependsOn\": [\n              {\n                \"externalId\": \"my.known.id\"\n              }\n            ],\n            \"lineageAnnotation\": {\n              \"sources\": [\n                {\n                  \"uri\": \"cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings\"\n                }\n              ],\n              \"targets\": [\n                {\n                  \"uri\": \"cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings\"\n                }\n              ]\n            }\n          }\n        ],\n        \"description\": \"<string>\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"items\": [\n    {\n      \"workflowExternalId\": \"<string>\",\n      \"version\": \"<string>\",\n      \"workflowDefinition\": {\n        \"tasks\": [\n          {\n            \"externalId\": \"<string>\",\n            \"parameters\": {\n              \"isAsyncComplete\": false\n            },\n            \"name\": \"<string>\",\n            \"description\": \"<string>\",\n            \"retries\": 3,\n            \"timeout\": 3600,\n            \"onFailure\": \"abortWorkflow\",\n            \"dependsOn\": [\n              {\n                \"externalId\": \"my.known.id\"\n              }\n            ],\n            \"lineageAnnotation\": {\n              \"sources\": [\n                {\n                  \"uri\": \"cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings\"\n                }\n              ],\n              \"targets\": [\n                {\n                  \"uri\": \"cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings\"\n                }\n              ]\n            }\n          }\n        ],\n        \"description\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows/versions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"items\": [\n    {\n      \"workflowExternalId\": \"<string>\",\n      \"version\": \"<string>\",\n      \"workflowDefinition\": {\n        \"tasks\": [\n          {\n            \"externalId\": \"<string>\",\n            \"parameters\": {\n              \"isAsyncComplete\": false\n            },\n            \"name\": \"<string>\",\n            \"description\": \"<string>\",\n            \"retries\": 3,\n            \"timeout\": 3600,\n            \"onFailure\": \"abortWorkflow\",\n            \"dependsOn\": [\n              {\n                \"externalId\": \"my.known.id\"\n              }\n            ],\n            \"lineageAnnotation\": {\n              \"sources\": [\n                {\n                  \"uri\": \"cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings\"\n                }\n              ],\n              \"targets\": [\n                {\n                  \"uri\": \"cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings\"\n                }\n              ]\n            }\n          }\n        ],\n        \"description\": \"<string>\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "workflowExternalId": "<string>",
      "version": "<string>",
      "workflowDefinition": {
        "hash": "<string>",
        "tasks": [
          {
            "externalId": "<string>",
            "parameters": {
              "function": {
                "externalId": "my.known.id",
                "data": {
                  "key1": "value1",
                  "key2": "value2"
                }
              },
              "isAsyncComplete": false
            },
            "name": "<string>",
            "description": "<string>",
            "retries": 3,
            "timeout": 3600,
            "onFailure": "abortWorkflow",
            "dependsOn": [
              {
                "externalId": "my.known.id"
              }
            ],
            "lineageAnnotation": {
              "sources": [
                {
                  "uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
                }
              ],
              "targets": [
                {
                  "uri": "cdf://westeurope-1/my-project/domain/my-domain/raw/sensors/readings"
                }
              ]
            }
          }
        ],
        "description": "<string>"
      },
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Body

application/json
​
items
object[]
Required array length: 1 element

Response

200 - application/json

Workflow version created/updated

​
items
Workflow Version · object[]
Required array length: 1 element
Last modified on July 13, 2026