Cognite Document parsing API
The Document parsing API from Cognite — 1 operation(s) for document parsing.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/cognite-document-parsing-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Cognite Document parsing 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: Document parsing
paths:
/context/documentparser/jobs/write:
post:
summary: Write Results to Data Models (INTERNAL)
operationId: writeResultsToDataModels
tags:
- Document parsing
description: Write results to data models.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentParserWriteResultsRequest'
responses:
'200':
description: Results written to data models successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentParserWriteResultsResponse'
components:
schemas:
ViewStatus:
type: string
enum:
- instance_updated
- instance_created
- waiting
description: 'The status of the instance written to the View of Data Models.
'
RawResponseItem:
allOf:
- $ref: '#/components/schemas/RawResponseItemCore'
- type: object
properties:
otherAnswers:
type: array
items:
$ref: '#/components/schemas/RawResponseItemCore'
required:
- otherAnswers
RawResponseItemCore:
type: object
properties:
fileId:
type: integer
description: The internal ID for the File.
pageNum:
type: integer
description: Page number the answer is in.
propertyId:
type: string
description: property_id of the View
spatialData:
$ref: '#/components/schemas/SpatialData'
description: The relative position in the document where the data was found.
value:
type: object
description: The extracted value returned in the expected data type.
selectedAnswerIndex:
type: integer
description: This field is the index of the selected answer. If index is -1, it means that the main answer is selected. If index is 0 or greater, it means that the answer at that index in the other_answers list is selected.
required:
- fileId
- pageNum
- propertyId
- spatialData
- value
NodeOrEdgeExternalId:
type: string
pattern: ^[^\\x00]{1,256}$
minLength: 1
maxLength: 256
RawResponses:
type: object
description: 'A dictionary where each key represents a property name (e.g., ''operatingPressure'') and the value is a ''RawResponseItem'' schema.
'
additionalProperties:
$ref: '#/components/schemas/RawResponseItem'
SpaceSpecification:
type: string
pattern: ^[a-zA-Z][a-zA-Z0-9_-]{0,41}[a-zA-Z0-9]?$
minLength: 1
maxLength: 43
SpatialData:
type: object
properties:
xMax:
type: number
format: double
description: Normalized x coordinate.
xMin:
type: number
format: double
description: Normalized x coordinate.
yMax:
type: number
format: double
description: Normalized x coordinate.
yMin:
type: number
format: double
description: Normalized x coordinate.
required:
- xMax
- xMin
- yMax
- yMin
DocumentParserWriteResultsResponse:
type: object
required:
- items
properties:
items:
type: array
items:
type: object
properties:
jobId:
$ref: '#/components/schemas/JobId'
viewStatus:
$ref: '#/components/schemas/ViewStatus'
node:
$ref: '#/components/schemas/Node'
required:
- jobId
- viewStatus
- node
DocumentParserWriteResultsRequest:
type: object
required:
- jobId
- data
properties:
jobId:
$ref: '#/components/schemas/JobId'
data:
$ref: '#/components/schemas/RawResponses'
node:
$ref: '#/components/schemas/Node'
JobId:
description: Contextualization job ID.
type: integer
example: 123
format: int64
Node:
type: object
description: 'Data Model node ID where parsed document results are written to.
'
properties:
externalId:
allOf:
- $ref: '#/components/schemas/NodeOrEdgeExternalId'
space:
allOf:
- $ref: '#/components/schemas/SpaceSpecification'
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:
- ''