JavaScript SDK
const files = await client.files.search({
filter: {
mimeType: 'image/jpeg',
},
search: {
name: 'Pump'
}
});res = client.files.search(name="some name")
my_label_filter = LabelFilter(contains_all=["WELL LOG"])
res = client.assets.search(name="xyz",filter=FileMetadataFilter(labels=my_label_filter))curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"name": "<string>",
"directoryPrefix": "/my/known/directory",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"assetExternalIds": [
"externalId1",
"externalId2",
"externalId3"
],
"rootAssetIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"dataSetIds": [
{
"id": 4503599627370496
}
],
"assetSubtreeIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"source": "<string>",
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"uploadedTime": {
"max": 1,
"min": 1
},
"sourceCreatedTime": {
"max": 1,
"min": 1
},
"sourceModifiedTime": {
"max": 1,
"min": 1
},
"externalIdPrefix": "my.known.prefix",
"uploaded": true,
"labels": {
"containsAny": [
{
"externalId": "my.known.id"
}
]
}
},
"search": {
"name": "<string>"
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/search",
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([
'filter' => [
'name' => '<string>',
'directoryPrefix' => '/my/known/directory',
'mimeType' => 'image/jpeg',
'metadata' => [
],
'assetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'assetExternalIds' => [
'externalId1',
'externalId2',
'externalId3'
],
'rootAssetIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
],
'assetSubtreeIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'source' => '<string>',
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'uploadedTime' => [
'max' => 1,
'min' => 1
],
'sourceCreatedTime' => [
'max' => 1,
'min' => 1
],
'sourceModifiedTime' => [
'max' => 1,
'min' => 1
],
'externalIdPrefix' => 'my.known.prefix',
'uploaded' => true,
'labels' => [
'containsAny' => [
[
'externalId' => 'my.known.id'
]
]
]
],
'search' => [
'name' => '<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}/files/search"
payload := strings.NewReader("{\n \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"search\": {\n \"name\": \"<string>\"\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}/files/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"search\": {\n \"name\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/search")
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 \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"search\": {\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"name": "<string>",
"id": 4503599627370496,
"uploaded": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "my.known.id",
"directory": "<string>",
"source": "<string>",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
4503599627370496
],
"dataSetId": 4503599627370496,
"sourceCreatedTime": 1730204346000,
"sourceModifiedTime": 1730204346000,
"securityCategories": [
4503599627370496
],
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
},
"uploadedTime": 1730204346000,
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Required capabilities:
filesAcl:READ
Search for files based on relevance. You can also supply a strict match filter as in Filter files, and search in the results from the filter. Returns first 1000 results based on relevance. This operation does not support pagination.
Request throttling
This endpoint is intended for data analytics and exploration purposes. It is not designed to support high-throughput data retrieval. Please note that this endpoint is subject to the new throttling policy, which imposes limits on both request rate and concurrency. For more details, please refer to the Files resource documentation.
POST
/
files
/
search
JavaScript SDK
const files = await client.files.search({
filter: {
mimeType: 'image/jpeg',
},
search: {
name: 'Pump'
}
});res = client.files.search(name="some name")
my_label_filter = LabelFilter(contains_all=["WELL LOG"])
res = client.assets.search(name="xyz",filter=FileMetadataFilter(labels=my_label_filter))curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"filter": {
"name": "<string>",
"directoryPrefix": "/my/known/directory",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
363848954441724,
793045462540095,
1261042166839739
],
"assetExternalIds": [
"externalId1",
"externalId2",
"externalId3"
],
"rootAssetIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"dataSetIds": [
{
"id": 4503599627370496
}
],
"assetSubtreeIds": [
{
"id": 123456789
},
{
"externalId": "system 99 external Id 1234"
}
],
"source": "<string>",
"createdTime": {
"max": 1,
"min": 1
},
"lastUpdatedTime": {
"max": 1,
"min": 1
},
"uploadedTime": {
"max": 1,
"min": 1
},
"sourceCreatedTime": {
"max": 1,
"min": 1
},
"sourceModifiedTime": {
"max": 1,
"min": 1
},
"externalIdPrefix": "my.known.prefix",
"uploaded": true,
"labels": {
"containsAny": [
{
"externalId": "my.known.id"
}
]
}
},
"search": {
"name": "<string>"
}
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/search",
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([
'filter' => [
'name' => '<string>',
'directoryPrefix' => '/my/known/directory',
'mimeType' => 'image/jpeg',
'metadata' => [
],
'assetIds' => [
363848954441724,
793045462540095,
1261042166839739
],
'assetExternalIds' => [
'externalId1',
'externalId2',
'externalId3'
],
'rootAssetIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'dataSetIds' => [
[
'id' => 4503599627370496
]
],
'assetSubtreeIds' => [
[
'id' => 123456789
],
[
'externalId' => 'system 99 external Id 1234'
]
],
'source' => '<string>',
'createdTime' => [
'max' => 1,
'min' => 1
],
'lastUpdatedTime' => [
'max' => 1,
'min' => 1
],
'uploadedTime' => [
'max' => 1,
'min' => 1
],
'sourceCreatedTime' => [
'max' => 1,
'min' => 1
],
'sourceModifiedTime' => [
'max' => 1,
'min' => 1
],
'externalIdPrefix' => 'my.known.prefix',
'uploaded' => true,
'labels' => [
'containsAny' => [
[
'externalId' => 'my.known.id'
]
]
]
],
'search' => [
'name' => '<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}/files/search"
payload := strings.NewReader("{\n \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"search\": {\n \"name\": \"<string>\"\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}/files/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"search\": {\n \"name\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/files/search")
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 \"filter\": {\n \"name\": \"<string>\",\n \"directoryPrefix\": \"/my/known/directory\",\n \"mimeType\": \"image/jpeg\",\n \"metadata\": {},\n \"assetIds\": [\n 363848954441724,\n 793045462540095,\n 1261042166839739\n ],\n \"assetExternalIds\": [\n \"externalId1\",\n \"externalId2\",\n \"externalId3\"\n ],\n \"rootAssetIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"dataSetIds\": [\n {\n \"id\": 4503599627370496\n }\n ],\n \"assetSubtreeIds\": [\n {\n \"id\": 123456789\n },\n {\n \"externalId\": \"system 99 external Id 1234\"\n }\n ],\n \"source\": \"<string>\",\n \"createdTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"lastUpdatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"uploadedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceCreatedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"sourceModifiedTime\": {\n \"max\": 1,\n \"min\": 1\n },\n \"externalIdPrefix\": \"my.known.prefix\",\n \"uploaded\": true,\n \"labels\": {\n \"containsAny\": [\n {\n \"externalId\": \"my.known.id\"\n }\n ]\n }\n },\n \"search\": {\n \"name\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"name": "<string>",
"id": 4503599627370496,
"uploaded": true,
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"externalId": "my.known.id",
"directory": "<string>",
"source": "<string>",
"mimeType": "image/jpeg",
"metadata": {},
"assetIds": [
4503599627370496
],
"dataSetId": 4503599627370496,
"sourceCreatedTime": 1730204346000,
"sourceModifiedTime": 1730204346000,
"securityCategories": [
4503599627370496
],
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
},
"uploadedTime": 1730204346000,
"instanceId": {
"space": "<string>",
"externalId": "<string>"
}
}
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}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
Response
The response for a successful files/byids, files/search or files/update operation
Show child attributes
Show child attributes
Last modified on July 10, 2026
Was this page helpful?
⌘I