cognite-sdk Logo
  • Quickstart
  • Settings
  • Credential Providers
  • Sync and Async Clients
  • Extensions and optional dependencies
  • Identity and access management
  • Data Modeling
  • Agents
  • AI
  • Assets (legacy)
  • Events (legacy)
  • Documents
    • Documents API
    • Preview
      • Download PDF Preview to Path
      • Download PDF Preview Bytes
      • Download Image Preview to Path
      • Download Image Preview Bytes
      • Retrieve PDF Preview Temporary Link
        • AsyncCogniteClient.documents.previews.retrieve_pdf_link()
  • Files
  • Time Series
  • Sequences
  • 3D
  • Contextualization
  • Data Ingestion
  • Transformations
  • Functions
  • Data Workflows
  • Simulators
  • Geospatial
  • Unit Catalog
  • Hosted Extractors
  • Postgres Gateway
  • Data Organization
  • Limits
  • Filters
  • Deprecated
  • Exceptions
  • Testing
  • Utils
  • Base data classes
  • Upsert
  • Update and Upsert Mode Parameter
  • Alpha and Beta Features
cognite-sdk
  • Documents
  • Retrieve PDF Preview Temporary Link
  • View page source

Retrieve PDF Preview Temporary Link

async AsyncCogniteClient.documents.previews.retrieve_pdf_link(
id: int,
) → TemporaryLink

Retrieve a Temporary link to download pdf preview.

Parameters:

id (int) – The server-generated ID for the document you want to retrieve the preview of.

Returns:

A temporary link to download the pdf preview.

Return type:

TemporaryLink

Examples

Retrieve the PDF preview download link for document with id 123:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> link = client.documents.previews.retrieve_pdf_link(id=123)
Previous Next

© Copyright 2017-2026, Cognite AS.

Built with Sphinx using a theme provided by Read the Docs.