Call Function Endpoint
Calls a function app with a request envelope. The HTTP status is 200 when the function finishes. Requires functionsAcl:WRITE. See Function app calls.
Authorizations
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.
Scopes
Headers
Prefer header for async execution (RFC 7240).
Set to respond-async to receive HTTP 202 with a Location header for polling.
Path Parameters
Function external ID
Response
Successful Response
The response contains the function call result envelope.
runtimeStatus indicates the outcome: Completed, Failed, or Timeout.
The response field is present only for Completed calls.
ID of the call, for log correlation.
ID of the function that was called.
Cognite Functions platform status. Running is not returned for synchronous calls.
Completed, Failed, Timeout Function response envelope, present only when runtimeStatus is Completed.
Cognite API error, present when the response fetch returns 400.