Cognite Document preview API
The document preview service is a utility API that can render most document types as an image or PDF.This can be very helpful if you want to display a preview of a file in a frontend, or for othertasks that require one of these formats.For both rendered formats there is a concept of a page. The actual meaning of a page depends onthe source document. E.g. an image will always have exactly one page, while a spreadsheetwill typically have one page representing each individual sheet.The document preview service can only generate preview for document sizes that do notexceed 150 MiB. Trying to preview a larger document will give an error.### File type supportPreviews can be created for the following types of files:- PDF files- Spreadsheets, documents and presentations from the Microsoft and Libre Office office suites- Images
Cognite Document preview API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Document preview. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 3 operations across 3 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version v1.
Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Cognite Document preview API declares
5 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token).
It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope.
It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope.
It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope.
It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration.
By default, every request must be authenticated.
oidc-token— 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 acce…oauth2-client-credentials— 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 acce…oauth2-auth-code— 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 acce…oauth2-open-industrial-data— Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.org-oidc-token— 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 obtain…
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.
The document preview service is a utility API that can render most document types as an image or PDF. This can be very helpful if you want to display a preview of a file in a fron…
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is Error (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Cognite 12
Other APIs Cognite publishes across the network.
This is an independent, third-party profile of Cognite Document preview API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.