How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Simulator Models API

The simulator model resource represents an asset modeled in a simulator. This asset could range from a pump or well to a complete processing facility or refinery.The simulator model is the root of its associated revisions, routines, runs, and results. The dataset assigned to a model is inherited by its children. Deleting a model also deletes all its children, thereby maintaining the integrity and hierarchy of the simulation data.Simulator model revisions track changes and updates to a simulator model over time. Each revision ensures that modifications to models are traceable and allows users to understand the evolution of a given model.#### Limitations:- A project can have a maximum of 1000 simulator models.- Each simulator model can have a maximum of 200 revisions.

Cognite Simulator Models API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Simulator Models. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 9 paths, and defines 33 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}.

9 operations 9 paths 33 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Simulator Models 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 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

Simulator Models 9

The simulator model resource represents an asset modeled in a simulator. This asset could range from a pump or well to a complete processing facility or refinery. The simulator mo…

POST
/simulators/models
Create Simulator Model
create_simulator_model_simulators_models_post body → 201400403500
POST
/simulators/models/list
Filter Simulator Models
filter_simulator_models_simulators_models_list_post body → 200400403500
POST
/simulators/models/aggregate
Aggregate Simulator Models
aggregate_simulator_models body → 200400403500
POST
/simulators/models/delete
Delete Simulator Model
delete_simulator_model_simulators_models_delete_post body → 200403500
POST
/simulators/models/update
Update Simulator Model
update_simulator_model_simulators_models_update_post body → 200400403500
POST
/simulators/models/byids
Retrieve Simulator Model
retrieve_simulator_model_simulators_models_byids_post body → 200400403500
POST
/simulators/models/revisions
Create Simulator Model Revision
create_simulator_model_revision_simulators_models_revisions_post body → 201400403500
POST
/simulators/models/revisions/list
Filter Simulator Model Revisions
filter_simulator_model_revisions_simulators_models_revisions_list_post body → 200400403500
POST
/simulators/models/revisions/byids
Retrieve Simulator Model Revisions
retrieve_simulator_model_revisions_simulators_models_revisions_byids_post body → 200400403500

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are SimulatorModelRevisionView (14 properties), SimulatorModelRevision (14 properties), SimulatorModel (9 properties), SimulatorModelCreateCommand (6 properties). Each schema is shown below with its type and property counts.

APIError
object
2 properties 2 required
ListSimulatorModelRevisionsQuery
object
4 properties
InputItemsIdRefOrExternalIdRef
object
1 property 1 required
EmptyResponse
object
SimulatorModelCreateCommand
object
6 properties 5 required
SimulatorModelRevision
object
14 properties 11 required
ListWithCursorSimulatorModel
object
2 properties 1 required
SingleItemIdRefOrExternalIdRef
object
1 property 1 required
UpdateSetString
object
1 property 1 required
ListSimulatorModelsQuery
object
4 properties
SimulatorModelUpdate
object
2 properties
ListAggregateCount
object
1 property 1 required
ListSimulatorModelsFilters
object
3 properties
SimulatorModelUpdateCommand
object
2 properties 2 required
SingleItemSimulatorModelCreateCommand
object
1 property 1 required
SingleItemSimulatorModelRevisionCreateCommand
object
1 property 1 required
IdRef
object
1 property 1 required
ListSimulatorModelRevision
object
1 property 1 required
ListWithCursorSimulatorModelRevisionView
object
2 properties 1 required
SingleItemSimulatorModelUpdateCommand
object
1 property 1 required
AggregateSimulatorModelsQuery
object
2 properties 1 required
ErrorBase
object
1 property 1 required
SimulatorModel
object
9 properties 7 required
SimulatorModelRevisionView
object
14 properties 11 required
ListSimulatorModelRevisionsFilters
object
5 properties
ExternalIdRef
object
1 property 1 required
SortByCreatedTime
object
2 properties 2 required
EpochTimestampRange
object
Range between two timestamps (inclusive).
2 properties
UpdateSetShortStr
object
1 property 1 required
SimulatorModelRevisionStatus
string
ListSimulatorModel
object
1 property 1 required
AggregateCount
object
1 property 1 required
SimulatorModelRevisionCreateCommand
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-simulator-models-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Simulator Models 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.