curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/function-apps/{functionExternalId}/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"path": "<string>",
"method": "<string>",
"body": {}
},
"nonce": "<string>"
}
'{
"callId": 123456,
"functionId": 789,
"runtimeStatus": "Completed",
"response": {
"status_code": 200,
"data": {
"id": "item-123",
"name": "Example item",
"created_at": "2026-03-22T12:00:00Z"
}
}
}Call Function Endpoint
Required capabilities:
functionsAcl:WRITE
Call a function app endpoint via a request envelope.
The SDK constructs a FunctionAppCallRequest containing the target path,
HTTP method, request body, and session nonce. The API validates and
forwards it to the function.
Response passthrough: The function’s typed response envelope is
returned as-is in the HTTP body. The HTTP status code is always 200
when the function call completes (regardless of the function’s own
status code). Non-200 HTTP status indicates an API-level failure.
Async mode: Send Prefer: respond-async to receive HTTP 202
with a Location header pointing to the poll URL.
Example:
{
"data": {
"path": "/items/123",
"method": "GET",
"body": {}
},
"nonce": "session-nonce"
}
curl --request POST \
--url https://{cluster}.cognitedata.com/api/v1/projects/{project}/function-apps/{functionExternalId}/calls \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"path": "<string>",
"method": "<string>",
"body": {}
},
"nonce": "<string>"
}
'{
"callId": 123456,
"functionId": 789,
"runtimeStatus": "Completed",
"response": {
"status_code": 200,
"data": {
"id": "item-123",
"name": "Example item",
"created_at": "2026-03-22T12:00:00Z"
}
}
}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.
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
Body
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.
Show child attributes
Show child attributes
Was this page helpful?