Retrieve file metadata by id

async AsyncCogniteClient.files.retrieve(
id: int | None = None,
external_id: str | None = None,
instance_id: NodeId | None = None,
) → FileMetadata | None

Retrieve a single file metadata by id.

Deprecated since version 8.23.0: The (asset-centric) Files metadata API is deprecated and is scheduled for removal on 2027-12-31. Create and query files as CogniteFile instances in the core data model (file content upload/download remain available via instance_id). See https://docs.cognite.com/cdf/deprecated for details and migration guidance.

Parameters:

  • id (int | None) – ID

  • external_id (str | None) – External ID

  • instance_id (NodeId | None) – Instance ID

Returns:

Requested file metadata or None if it does not exist.

Return type:

FileMetadata | None

Tip

If you are working with Data Modeling, consider using client.data_modeling.files.retrieve instead.

Examples

Get file metadata by instance id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> from cognite.client.data_classes.data_modeling import NodeId
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.files.retrieve(instance_id=NodeId("my-space", "my-file-xid"))

Get file metadata by external id:

>>> res = client.files.retrieve(external_id="1")