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 Function calls API

Function calls let you execute functions asynchronously with a timeout of 15 minutes.

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

Tagged areas include Function calls. The published artifact set on APIs.io includes an OpenAPI specification.

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

7 operations 7 paths 20 schemas 4 GET3 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 Function calls 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 7

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

Function calls 7

Function calls let you execute functions asynchronously with a timeout of 15 minutes.

POST
/functions/{functionId}/call
Call a function asynchronously
postFunctionsCall 1 param body → 201400429
GET
/functions/{functionId}/calls
List function calls
getFunctionCalls 3 params → 200400
POST
/functions/{functionId}/calls/byids
Retrieve calls
byIdsFunctionCalls 1 param body → 200400
GET
/functions/{functionId}/calls/{callId}
Retrieve a function call by its id
getFunctionCall 2 params → 200400
GET
/functions/{functionId}/calls/{callId}/logs
Retrieve logs for function call
getFunctionCallLogs 2 params → 200400
GET
/functions/{functionId}/calls/{callId}/response
Retrieve response for function call
getFunctionCallResponse 2 params → 200400
POST
/functions/{functionId}/calls/list
Filter function calls
listFunctionCalls 1 param body → 200400

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are FunctionCall (8 properties), Error (4 properties), FunctionCallLogEntry (2 properties), FunctionCallsWithCursor (2 properties). Each schema is shown below with its type and property counts.

FunctionCallIds
object
Cursor
object
Cursor for paging through results. In general, if a response contains a nextCursor property, it means that there may be more results, and you should pass that…
1 property
429Error
object
Cognite API throttling.
2 properties 2 required
FunctionCalls
object
1 property 1 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
data
object
Input data to the function (only present if provided on the schedule). This data is passed deserialized into the function through one of the arguments called d…
CogniteInternalId
integer
A server-generated ID for the object.
FunctionCallListScope
nonce
string
Nonce retrieved from sessions API when creating a session. This will be used to bind the session before executing the function. The corresponding access token…
FunctionCallStatus
string
Status of the function call.
FunctionCallsWithCursor
object
2 properties 1 required
FunctionCallId
object
1 property 1 required
LimitList
object
1 property
Error
object
Cognite API error.
4 properties 2 required
FunctionCallFilter
object
1 property
EpochTimestampRange
object
Range between two timestamps (inclusive).
2 properties
FunctionCallRequest
object
2 properties 1 required
FunctionCallLogEntry
object
2 properties
FunctionCall
object
8 properties 4 required
IgnoreUnknownIdsField
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-function-calls-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 Function calls 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.