const assets = [
{ name: 'First asset' },
{ name: 'Second asset', description: 'Another asset', externalId: 'anotherAsset' },
{ name: 'Child asset', parentExternalId: 'anotherAsset'},
];
const createdAssets = await client.assets.create(assets);from cognite.client.data_classes import AssetWrite
assets = [AssetWrite(name="asset1"), AssetWrite(name="asset2")]
res = client.assets.create(assets)
from cognite.client.data_classes import AssetWrite, Label
asset = AssetWrite(name="my_pump", labels=[Label(external_id="PUMP")])
res = client.assets.create(asset)List<Asset> upsertAssetsList = List.of(Asset.newBuilder()
.setExternalId("10")
.setName("generated_asset_")
.setDescription("generated_asset_description_")
.setSource("sdk-data-generator")
.putMetadata("type", "sdk-data-generator")
.build());
List<Asset> upsertedAssets = client.assets().upsert(upsertAssetsList);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"externalId": "my.known.id",
"parentId": 4503599627370496,
"parentExternalId": "my.known.id",
"description": "<string>",
"dataSetId": 4503599627370496,
"metadata": {},
"source": "<string>",
"labels": [
{
"externalId": "my.known.id"
}
]
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets",
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' => [
[
'name' => '<string>',
'externalId' => 'my.known.id',
'parentId' => 4503599627370496,
'parentExternalId' => 'my.known.id',
'description' => '<string>',
'dataSetId' => 4503599627370496,
'metadata' => [
],
'source' => '<string>',
'labels' => [
[
'externalId' => 'my.known.id'
]
]
]
]
]),
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}/assets"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"parentId\": 4503599627370496,\n \"parentExternalId\": \"my.known.id\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"metadata\": {},\n \"source\": \"<string>\",\n \"labels\": [\n {\n \"externalId\": \"my.known.id\"\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets")
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 \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"parentId\": 4503599627370496,\n \"parentExternalId\": \"my.known.id\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"metadata\": {},\n \"source\": \"<string>\",\n \"labels\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"rootId": 4503599627370496,
"name": "<string>",
"id": 4503599627370496,
"aggregates": {
"childCount": 1,
"depth": 1,
"path": [
{
"id": 4503599627370496
}
]
},
"parentId": 4503599627370496,
"parentExternalId": "my.known.id",
"externalId": "my.known.id",
"description": "<string>",
"dataSetId": 4503599627370496,
"metadata": {},
"source": "<string>",
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 429,
"message": "Project exceeded maximum number='50' of concurrent requests. Please try again later."
}
}Required capabilities:
assetsAcl:WRITE
Create multiple asset objects in the same project. It is possible to create a maximum of 1000 assets per request.
Request throttling
This endpoint is a subject of the new throttling schema (limited request rate and concurrency). Please check Assets resource description for more information.
const assets = [
{ name: 'First asset' },
{ name: 'Second asset', description: 'Another asset', externalId: 'anotherAsset' },
{ name: 'Child asset', parentExternalId: 'anotherAsset'},
];
const createdAssets = await client.assets.create(assets);from cognite.client.data_classes import AssetWrite
assets = [AssetWrite(name="asset1"), AssetWrite(name="asset2")]
res = client.assets.create(assets)
from cognite.client.data_classes import AssetWrite, Label
asset = AssetWrite(name="my_pump", labels=[Label(external_id="PUMP")])
res = client.assets.create(asset)List<Asset> upsertAssetsList = List.of(Asset.newBuilder()
.setExternalId("10")
.setName("generated_asset_")
.setDescription("generated_asset_description_")
.setSource("sdk-data-generator")
.putMetadata("type", "sdk-data-generator")
.build());
List<Asset> upsertedAssets = client.assets().upsert(upsertAssetsList);curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"items": [
{
"name": "<string>",
"externalId": "my.known.id",
"parentId": 4503599627370496,
"parentExternalId": "my.known.id",
"description": "<string>",
"dataSetId": 4503599627370496,
"metadata": {},
"source": "<string>",
"labels": [
{
"externalId": "my.known.id"
}
]
}
]
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets",
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' => [
[
'name' => '<string>',
'externalId' => 'my.known.id',
'parentId' => 4503599627370496,
'parentExternalId' => 'my.known.id',
'description' => '<string>',
'dataSetId' => 4503599627370496,
'metadata' => [
],
'source' => '<string>',
'labels' => [
[
'externalId' => 'my.known.id'
]
]
]
]
]),
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}/assets"
payload := strings.NewReader("{\n \"items\": [\n {\n \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"parentId\": 4503599627370496,\n \"parentExternalId\": \"my.known.id\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"metadata\": {},\n \"source\": \"<string>\",\n \"labels\": [\n {\n \"externalId\": \"my.known.id\"\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))
}require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/assets")
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 \"name\": \"<string>\",\n \"externalId\": \"my.known.id\",\n \"parentId\": 4503599627370496,\n \"parentExternalId\": \"my.known.id\",\n \"description\": \"<string>\",\n \"dataSetId\": 4503599627370496,\n \"metadata\": {},\n \"source\": \"<string>\",\n \"labels\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"rootId": 4503599627370496,
"name": "<string>",
"id": 4503599627370496,
"aggregates": {
"childCount": 1,
"depth": 1,
"path": [
{
"id": 4503599627370496
}
]
},
"parentId": 4503599627370496,
"parentExternalId": "my.known.id",
"externalId": "my.known.id",
"description": "<string>",
"dataSetId": 4503599627370496,
"metadata": {},
"source": "<string>",
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
}
}
]
}{
"error": {
"code": 400,
"message": "`null` values aren't allowed."
}
}{
"error": {
"code": 429,
"message": "Project exceeded maximum number='50' of concurrent requests. Please try again later."
}
}Authorizations
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
List of the assets to create. You can create a maximum of 1000 assets per request.
1 - 1000 elementsShow child attributes
Show child attributes
Response
Response with list of assets.
Show child attributes
Show child attributes
Was this page helpful?