Run parsing for files
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"libraryId": "my.known.id",
"nonce": "<string>"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection"
payload = {
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"libraryId": "my.known.id",
"nonce": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documents: [{fileId: {space: '<string>', externalId: 'my.known.id'}, pageNumber: 123}],
libraryId: 'my.known.id',
nonce: '<string>'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection', 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}/diagram-parsing/parsing/symbol-detection",
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([
'documents' => [
[
'fileId' => [
'space' => '<string>',
'externalId' => 'my.known.id'
],
'pageNumber' => 123
]
],
'libraryId' => 'my.known.id',
'nonce' => '<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}/diagram-parsing/parsing/symbol-detection"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"libraryId\": \"my.known.id\",\n \"nonce\": \"<string>\"\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}/diagram-parsing/parsing/symbol-detection")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"libraryId\": \"my.known.id\",\n \"nonce\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection")
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 \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"libraryId\": \"my.known.id\",\n \"nonce\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
"my.known.id"
]
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Run parsing for files
Required capabilities:
diagramParsingAcl:WRITE
Start a parsing job on files to detect their symbols and connections.
POST
/
diagram-parsing
/
parsing
/
symbol-detection
Run parsing for files
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"libraryId": "my.known.id",
"nonce": "<string>"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection"
payload = {
"documents": [
{
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
}
],
"libraryId": "my.known.id",
"nonce": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
documents: [{fileId: {space: '<string>', externalId: 'my.known.id'}, pageNumber: 123}],
libraryId: 'my.known.id',
nonce: '<string>'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection', 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}/diagram-parsing/parsing/symbol-detection",
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([
'documents' => [
[
'fileId' => [
'space' => '<string>',
'externalId' => 'my.known.id'
],
'pageNumber' => 123
]
],
'libraryId' => 'my.known.id',
'nonce' => '<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}/diagram-parsing/parsing/symbol-detection"
payload := strings.NewReader("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"libraryId\": \"my.known.id\",\n \"nonce\": \"<string>\"\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}/diagram-parsing/parsing/symbol-detection")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"libraryId\": \"my.known.id\",\n \"nonce\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/symbol-detection")
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 \"documents\": [\n {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n }\n ],\n \"libraryId\": \"my.known.id\",\n \"nonce\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
"my.known.id"
]
}{
"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
Specifies the library to use when parsing the given files.
Response
List of external IDs returned in a response
Required array length:
1 - 100 elementsThe external ID provided by the client. Must be unique for the resource type.
Maximum string length:
255Last modified on July 10, 2026
Was this page helpful?
⌘I