Run an instant parsing job for a file
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": {
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
},
"libraryId": "my.known.id"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant"
payload = {
"document": {
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
},
"libraryId": "my.known.id"
}
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({
document: {fileId: {space: '<string>', externalId: 'my.known.id'}, pageNumber: 123},
libraryId: 'my.known.id'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant', 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/instant",
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([
'document' => [
'fileId' => [
'space' => '<string>',
'externalId' => 'my.known.id'
],
'pageNumber' => 123
],
'libraryId' => '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}/diagram-parsing/parsing/instant"
payload := strings.NewReader("{\n \"document\": {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n },\n \"libraryId\": \"my.known.id\"\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/instant")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n },\n \"libraryId\": \"my.known.id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant")
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 \"document\": {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n },\n \"libraryId\": \"my.known.id\"\n}"
response = http.request(request)
puts response.read_body{
"entities": [
{
"externalId": "my.known.id",
"pathIds": [
"<string>"
],
"symbolId": "my.known.id"
}
],
"message": "<string>"
}{
"error": {
"code": 401,
"message": "Could not authenticate.",
"missing": [
{}
],
"duplicated": [
{}
]
}
}Run an instant parsing job for a file
Required capabilities:
diagramParsingAcl:WRITE
Start an instant parsing job on a file to detect diagram symbols based on the specified library. Parsed outputs do not persist.
POST
/
diagram-parsing
/
parsing
/
instant
Run an instant parsing job for a file
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"document": {
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
},
"libraryId": "my.known.id"
}
'import requests
url = "https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant"
payload = {
"document": {
"fileId": {
"space": "<string>",
"externalId": "my.known.id"
},
"pageNumber": 123
},
"libraryId": "my.known.id"
}
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({
document: {fileId: {space: '<string>', externalId: 'my.known.id'}, pageNumber: 123},
libraryId: 'my.known.id'
})
};
fetch('https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant', 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/instant",
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([
'document' => [
'fileId' => [
'space' => '<string>',
'externalId' => 'my.known.id'
],
'pageNumber' => 123
],
'libraryId' => '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}/diagram-parsing/parsing/instant"
payload := strings.NewReader("{\n \"document\": {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n },\n \"libraryId\": \"my.known.id\"\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/instant")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"document\": {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n },\n \"libraryId\": \"my.known.id\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{cluster}.cognitedata.com/api/v1/projects/{project}/diagram-parsing/parsing/instant")
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 \"document\": {\n \"fileId\": {\n \"space\": \"<string>\",\n \"externalId\": \"my.known.id\"\n },\n \"pageNumber\": 123\n },\n \"libraryId\": \"my.known.id\"\n}"
response = http.request(request)
puts response.read_body{
"entities": [
{
"externalId": "my.known.id",
"pathIds": [
"<string>"
],
"symbolId": "my.known.id"
}
],
"message": "<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
Specifies the library to use when instant parsing the given file.
Response
Temporary diagram entity detections in a given file based on the provided library.
Last modified on July 10, 2026
Was this page helpful?
⌘I