Skip to main content
POST
/
api
/
v1
/
projects
/
{project}
/
diagram-parsing
/
parsing
/
full
Run parsing with tag detection for files
curl --request POST \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/api/v1/projects/{project}/diagram-parsing/parsing/full \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "documents": [
    {
      "fileId": {
        "space": "<string>",
        "externalId": "my.known.id"
      },
      "pageNumber": 123
    }
  ],
  "filters": {
    "Asset": {},
    "File": {}
  },
  "libraryId": {
    "externalId": "my.known.id"
  },
  "nonce": "<string>",
  "minTokens": 123,
  "partialMatch": true,
  "searchField": "<string>"
}
'
{
  "items": [
    "my.known.id"
  ]
}

Authorizations

Authorization
string
header
required

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.

Path Parameters

project
string
required

The CDF project name, equal to the project variable in the server URL.

Example:

"publicdata"

Body

application/json

Defines parsing options needed for symbol and tag detection jobs.

documents
object[]
required
Required array length: 1 - 100 elements
filters
object
required

Map of filters for DMS list operations used to load assets and files

libraryId
object
required

The externalId of a library to use for parsing

nonce
string
required

Session nonce value

minTokens
integer

Each detected item must match the detected entity on at least this number of tokens. A token is a substring of consecutive letters or digits.

partialMatch
boolean

Allow partial (fuzzy) matching of entities in the engineering diagrams. Creates a match only when it is possible to do so unambiguously.

searchField
string

This field determines the string to search for and to identify object entities.

Response

List of external IDs returned in a response

items
string[]
required
Required array length: 1 - 100 elements

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Last modified on April 23, 2026