New: build custom CDF applications with Cognite Flows. Documentation · What's new.
call = client.functions.call(id=1)
func = client.functions.retrieve(id=1)
call = func.call(){
"id": 4503599627370496,
"status": "Running",
"startTime": 1730204346000,
"functionId": 4503599627370496,
"endTime": 1730204346000,
"error": "ZeroDivisionError: division by zero",
"scheduleId": 4503599627370496,
"scheduledTime": 1730204346000
}Call a function asynchronously
Required capabilities:
functionsAcl:RUN
Perform a function call. To provide input data to the function, add the data in an object called data in the request body. It will be available as the data argument into the function. Info about the function call at runtime can be obtained through the function_call_info argument if added in the function handle. WARNING: Secrets or other confidential information should not be passed via the data object. There is a dedicated secrets object in the request body to “Create functions” for this purpose.
call = client.functions.call(id=1)
func = client.functions.retrieve(id=1)
call = func.call(){
"id": 4503599627370496,
"status": "Running",
"startTime": 1730204346000,
"functionId": 4503599627370496,
"endTime": 1730204346000,
"error": "ZeroDivisionError: division by zero",
"scheduleId": 4503599627370496,
"scheduledTime": 1730204346000
}Documentation Index
Fetch the complete documentation index at: https://docs.cognite.com/llms.txt
Use this file to discover all available pages before exploring further.
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.
Path Parameters
The function id.
Body
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 will be passed to the function and used to instantiate the client of the handle() function. You can create a session via the Sessions API. When using the Python SDK, the session will be created behind the scenes when creating the schedule.
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 data. WARNING: Secrets or other confidential information should not be passed via the data object. There is a dedicated secrets object in the request body to "Create functions" for this purpose.'
{ "timeSeriesId1": 13435351, "maxValue": 4 }Response
Created
A server-generated ID for the object.
1 <= x <= 9007199254740991Status of the function call.
Running, Completed, Failed, Timeout "Running"
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
A server-generated ID for the object.
1 <= x <= 9007199254740991The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Error message when the call status is Failed or Timeout.
"ZeroDivisionError: division by zero"
A server-generated ID for the object.
1 <= x <= 9007199254740991The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
Was this page helpful?