Skip to main content
Asset-centric support in the diagram detect and convert endpoints (/context/diagram/detect and /context/diagram/convert) is deprecated. Reference files with fileInstanceId, pass entities from your data model, and store results in the core data model. The endpoints remain available for files in the core data model.See Deprecated and retired features for dates, and Diagram parsing for data modeling.
The engineering diagrams API detects annotations (equipment tags, connections) in engineering diagrams like piping and instrumentation diagrams (P&IDs) and process flow diagrams. You can also convert diagrams to image formats.

​
Asynchronous processing

Results are returned as asynchronous jobs. You submit a diagram for processing and receive a job ID. Poll the job status until it completes, then retrieve the detected annotations or converted images.

​
Supported content

The API works with common engineering diagram formats. Detected annotations include equipment identifiers, connection lines, and other visual elements. You can use these annotations to link diagram content to assets and other CDF resources.
Store detected diagram elements in the core data model. See Diagram parsing for data modeling. Storing results with the annotations API is deprecated.

​
Key capabilities

  • Detect annotations in P&IDs and process flow diagrams
  • Convert diagrams to standard image formats
  • Poll job status for async processing results
  • Retrieve outputs when jobs complete

​
OCR text

After diagram detect has parsed a file, POST /context/diagram/ocr returns the optical character recognition (OCR) text for that file. You can limit the result to a page range. Files that have not been processed by diagram detect return an empty result.
Last modified on October 7, 2026