Skip to main content
POST
/
workflows
Python SDK
from cognite.client.data_classes import WorkflowUpsert
wf = WorkflowUpsert(external_id="my_workflow", description="my workflow description")
res = client.workflows.upsert(wf)

wf2 = WorkflowUpsert(external_id="other", data_set_id=123)
res = client.workflows.upsert([wf, wf2])
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "<string>",
"description": "<string>",
"dataSetId": 4503599627370496,
"maxConcurrentExecutions": 5000
}
]
}
'
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [
{
externalId: '<string>',
description: '<string>',
dataSetId: 4503599627370496,
maxConcurrentExecutions: 5000
}
]
})
};

fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/workflows', 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",
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' => [
[
'externalId' => '<string>',
'description' => '<string>',
'dataSetId' => 4503599627370496,
'maxConcurrentExecutions' => 5000
]
]
]),
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"

payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"maxConcurrentExecutions\": 5000\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")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"maxConcurrentExecutions\": 5000\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"externalId\": \"<string>\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"maxConcurrentExecutions\": 5000\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "externalId": "<string>",
      "createdTime": 1730204346000,
      "lastUpdatedTime": 1730204346000,
      "description": "<string>",
      "dataSetId": 4503599627370496,
      "maxConcurrentExecutions": 5000
    }
  ]
}
{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}

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
Required array length: 1 element

Response

List of created workflows

items
Workflow · object[]
Last modified on July 10, 2026