Python SDK
from cognite.client.data_classes.data_modeling.streams import StreamWrite, StreamTemplate, StreamTemplateWriteSettings
res = client.data_modeling.streams.create(
StreamWrite(
external_id="my-stream",
settings=StreamTemplateWriteSettings(
template=StreamTemplate(name="BasicArchive"),
),
)
)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my-stream",
"settings": {
"template": {
"name": "BasicArchive"
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [{externalId: 'my-stream', settings: {template: {name: 'BasicArchive'}}}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams', 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}/streams",
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' => 'my-stream',
'settings' => [
'template' => [
'name' => 'BasicArchive'
]
]
]
]
]),
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}/streams"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my-stream\",\n \"settings\": {\n \"template\": {\n \"name\": \"BasicArchive\"\n }\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}/streams")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my-stream\",\n \"settings\": {\n \"template\": {\n \"name\": \"BasicArchive\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams")
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\": \"my-stream\",\n \"settings\": {\n \"template\": {\n \"name\": \"BasicArchive\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "test1",
"createdTime": 1730204346000,
"createdFromTemplate": "BasicArchive",
"type": "Immutable",
"settings": {
"lifecycle": {
"retainedAfterSoftDelete": "P42D",
"dataDeletedAfter": "P1Y"
},
"limits": {
"maxRecordsTotal": {
"provisioned": 1000,
"consumed": 999
},
"maxGigaBytesTotal": {
"provisioned": 1000,
"consumed": 999
},
"maxFilteringInterval": "P1Y"
}
}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 409,
"message": "<string>",
"duplicated": [
{
"externalId": "test1"
}
]
}
}Required capabilities:
streamsAcl:CREATE
Create a new stream. A stream is a target for high volume data ingestion, with data shaped by the Data Modeling concepts. Specify an external ID and a stream template for each stream. The template defines the stream’s mutability, limits, and lifecycle.
POST
/
streams
Python SDK
from cognite.client.data_classes.data_modeling.streams import StreamWrite, StreamTemplate, StreamTemplateWriteSettings
res = client.data_modeling.streams.create(
StreamWrite(
external_id="my-stream",
settings=StreamTemplateWriteSettings(
template=StreamTemplate(name="BasicArchive"),
),
)
)
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"externalId": "my-stream",
"settings": {
"template": {
"name": "BasicArchive"
}
}
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
items: [{externalId: 'my-stream', settings: {template: {name: 'BasicArchive'}}}]
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams', 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}/streams",
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' => 'my-stream',
'settings' => [
'template' => [
'name' => 'BasicArchive'
]
]
]
]
]),
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}/streams"
payload := strings.NewReader("{\n \"items\": [\n {\n \"externalId\": \"my-stream\",\n \"settings\": {\n \"template\": {\n \"name\": \"BasicArchive\"\n }\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}/streams")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"items\": [\n {\n \"externalId\": \"my-stream\",\n \"settings\": {\n \"template\": {\n \"name\": \"BasicArchive\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams")
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\": \"my-stream\",\n \"settings\": {\n \"template\": {\n \"name\": \"BasicArchive\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"externalId": "test1",
"createdTime": 1730204346000,
"createdFromTemplate": "BasicArchive",
"type": "Immutable",
"settings": {
"lifecycle": {
"retainedAfterSoftDelete": "P42D",
"dataDeletedAfter": "P1Y"
},
"limits": {
"maxRecordsTotal": {
"provisioned": 1000,
"consumed": 999
},
"maxGigaBytesTotal": {
"provisioned": 1000,
"consumed": 999
},
"maxFilteringInterval": "P1Y"
}
}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 409,
"message": "<string>",
"duplicated": [
{
"externalId": "test1"
}
]
}
}Authorizations
oidc-tokenoauth2-client-credentialsoauth2-open-industrial-dataoauth2-auth-code
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
Stream to create.
List of streams.
Response
Stream created.
Stream response.
List of streams.
Show child attributes
Show child attributes
Last modified on August 21, 2026
⌘I