Cognite 3D Files API

openapi: 3.2.0
info:
  title: Cognite 3D Files API
  description: '# Introduction

    This is the reference documentation for the Cognite API with

    an overview of all the available methods.'
  version: v1
  contact:
    name: Cognite Support
    url: https://support.cognite.com
    email: support@cognite.com
servers:
- url: https://{cluster}.cognitedata.com/api/v1/projects/{project}
  description: The URL for the CDF cluster to connect to
  variables:
    cluster:
      enum:
      - api
      - az-tyo-gp-001
      - az-eastus-1
      - az-power-no-northeurope
      - westeurope-1
      - asia-northeast1-1
      - gc-dsm-gp-001
      default: api
      description: The CDF cluster to connect to
    project:
      default: publicdata
      description: The CDF project name.
security:
- oidc-token:
  - https://{cluster}.cognitedata.com/.default
- oauth2-client-credentials:
  - https://{cluster}.cognitedata.com/.default
- oauth2-open-industrial-data:
  - https://api.cognitedata.com/.default
- oauth2-auth-code:
  - https://{cluster}.cognitedata.com/.default
tags:
- name: 3D Files
paths:
  /3d/files/{threedFileId}:
    get:
      tags:
      - 3D Files
      summary: Retrieve a single 3D file
      description: '> **Required capabilities:** `threedAcl:READ`


        Retrieve the contents of a 3D file. This applies to the output types ''ciff-processed'', ''ciff-partially-processed'' and ''node-property-metadata-json''.


        This endpoint supports tag-based caching.


        This endpoint is only compatible with 3D file IDs from the 3D API, and not compatible with

        file IDs from the Files API.'
      operationId: get3DFile
      parameters:
      - name: threedFileId
        in: path
        description: The ID of the 3D file to retrieve.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                type: string
                description: The raw contents of the file.
                format: binary
          headers:
            Content-Type:
              schema:
                type: string
              description: The media type of the file.
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-capability:
      - threedAcl:READ
      x-code-samples:
      - lang: JavaScript
        label: JavaScript SDK
        source: await client.files3D.retrieve(3744350296805509);
      - lang: Python
        label: Python SDK
        source: 'res = client.three_d.files.retrieve(1)

          '
      - lang: Java
        label: Java SDK
        source: "client.threeD().files().downloadToPath(1L, Paths.get(\"\")); \n\n"
  /3d/files/{threedFileId}/{subPath}:
    get:
      tags:
      - 3D Files
      summary: Retrieve a 3D directory file
      description: '> **Required capabilities:** `threedAcl:READ`


        Retrieve the contents of a 3D file, for a blobId which is of a directory type.

        This applies to the output types ''gltf-directory'', ''reveal-directory'', ''ept-pointcloud'', ''tiles-directory'', ''model-from-points''.


        The ''subPath'' elements, i.e. directory and/or file names, within each directory output type is subject to change and depends on each output type.

        - The ''gltf-directory'' output is used by Reveal v3+ for visualizing CAD files and contains a ''scene.json'' file, which describes what other files are available within the blobId.

        - The ''reveal-directory'' output is used by Reveal v1-2 for visualizing CAD files and contains a ''scene.json'' file, which describes what other files are available within the blobId.

        - The ''ept-pointcloud'' output is used by Reveal for visualizing point clouds, and contains a ''ept.json'' file. The ''ept.json'' file contains general information for the point cloud data. The file named ''ept-hierarchy/0-0-0-0.json'' for the same blobId lists all the output point files which can be retrieved from a ''ept-data'' folder for the same blobId, e.g. ''ept-data/0-0-0-0.bin''. The ''.bin'' files are in a custom point cloud format following the schema in the ''ept.json'' file. Additionally, a ''filterOptions.json'' file contains a description of which options were used when processing the point cloud.


        Experimental outputs, normally not enabled:

        The ''tiles-directory'' output contains files for classification of the point cloud data. Retrieve the ''tiles.json'' file from this output for a overview of the files within this output.

        The ''model-from-points'' output is used for storing a mesh based output file of some parts of the point cloud. This is stored as a ''model.ciff'' file, in the Cognite internal file format.


        This endpoint supports tag-based caching.


        This endpoint is only compatible with 3D file IDs from the 3D API, and not compatible with

        file IDs from the Files API.'
      operationId: get3DDirectoryFile
      parameters:
      - name: threedFileId
        in: path
        description: The blob ID of the 3D output directory.
        required: true
        schema:
          type: integer
          format: int64
      - name: subPath
        in: path
        description: The filename for the 3D file to retrieve.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            '*/*':
              schema:
                type: string
                description: The raw contents of the file.
                format: binary
          headers:
            Content-Type:
              schema:
                type: string
              description: The media type of the file.
        '400':
          $ref: '#/components/responses/ErrorResponse'
      x-capability:
      - threedAcl:READ
components:
  responses:
    ErrorResponse:
      description: The response for a failed request.
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            properties:
              error:
                $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - code
      - message
      description: Cognite API error.
      properties:
        code:
          type: integer
          description: HTTP status code.
          format: int32
          example: 401
        message:
          type: string
          description: Error message.
          example: Could not authenticate.
        missing:
          type: array
          description: List of lookup objects that do not match any results.
          items:
            type: object
            additionalProperties: true
        duplicated:
          type: array
          description: List of objects that are not unique.
          items:
            type: object
            additionalProperties: true
  securitySchemes:
    oidc-token:
      type: http
      scheme: bearer
      bearerFormat: OpenID Connect or OAuth2 token
      description: 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.
    oauth2-client-credentials:
      type: oauth2
      description: 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.
      flows:
        clientCredentials:
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-auth-code:
      type: oauth2
      description: 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.
      flows:
        authorizationCode:
          authorizationUrl: https://your-idps.authorization.url/
          tokenUrl: https://your-idps.token.url/
          scopes:
            default: https://{cluster}.cognitedata.com/.default
    oauth2-open-industrial-data:
      type: oauth2
      description: Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/48d5043c-cf70-4c49-881c-c638f5796997/oauth2/v2.0/token
          scopes:
            default: https://api.cognitedata.com/.default
    org-oidc-token:
      type: openIdConnect
      openIdConnectUrl: https://auth.cognite.com/.well-known/openid-configuration
      description: 'Access token issued by the Cognite authorization server, and valid for the target organization. The token must

        be an OpenID Connect token, and it can be obtained by performing an OIDC login flow toward `auth.cognite.com`.

        This is a single URL for all CDF organizations.'
x-tagGroups:
- name: Changelog
  tags:
  - Changelog
- name: Organizations and projects
  tags:
  - Organizations
  - Projects
- name: Identity and access management
  tags:
  - Principals
  - Groups
  - Security categories
  - Sessions
  - Token
  - User profiles
  - Project Deletion Reporting
- name: Data modeling
  tags:
  - Data Modeling
  - Data models
  - Spaces
  - Views
  - Containers
  - Nodes
  - Instances
  - Statistics
  - Streams
  - Records
- name: Asset-centric data model
  tags:
  - Assets
  - Time series
  - Synthetic Time Series
  - Data point subscriptions
  - Events
  - Files
  - Sequences
  - Geospatial
  - Seismic
- name: 3D
  tags:
  - 3D Models
  - 3D Model Revisions
  - 3D Files
  - 3D Asset Mapping
  - 3D Contextualization
  - 3D Jobs
  - 3D Migration
  - 3D Scenes
- name: Contextualization
  tags:
  - Entity matching
  - Entity matching pipelines
  - Engineering diagrams
  - Vision
  - Advanced joins
- name: Cognite AI
  tags:
  - Agents
  - Skills
  - Chat Completions
  - Document AI
  - Models
- name: Documents
  tags:
  - Documents
  - Document preview
- name: Data ingestion
  tags:
  - Raw
  - Extraction Pipelines
  - Extraction Pipelines Runs
  - Extraction Pipelines Config
  - Extractors
- name: Data organization
  tags:
  - Data sets
  - Data domains
  - Data products
  - Rule sets
  - Labels
  - Relationships
  - Annotations
- name: Transformations
  tags:
  - Transformations
  - Transformation Jobs
  - Transformation Schedules
  - Transformation Notifications
  - Query
  - Schema
- name: Functions
  tags:
  - Functions
  - Function calls
  - Function schedules
- name: Hosted Extractors
  tags:
  - Sources
  - Jobs
  - Destinations
  - Mappings
- name: PostgreSQL Gateway
  tags:
  - Postgres Gateway Users
  - Postgres Gateway Tables
- name: SAP Writeback
  tags:
  - SAP Instances
  - SAP Endpoints
  - Schema Mappings
  - Writeback Requests
- name: Data workflows
  tags:
  - Workflows
  - Workflow versions
  - Workflow executions
  - Workflow triggers
  - Tasks
  - Workers
- name: Simulators
  tags:
  - Simulators
  - Simulator Integrations
  - Simulator Models
  - Simulator Routines
  - Simulation Runs
  - Simulator Logs
- name: Units
  tags:
  - Units
  - Unit Systems
- name: ''
  tags:
  - ''