v1

latestOpenAPI 3.0.1raw.githubusercontent.com2024-10-113944112.8 KB
Envelope Function Invocation

Call Function

Invokes the specified function that was successfully deployed. If the version is not specified, any active function versions will handle the request. If the version is specified in the URI, then the request is exclusively processed by the designated version of the function. By default, this endpoint will block for 5 seconds. If the request is not fulfilled before the timeout, it's status is considered in-progress or pending and the response includes HTTP status code 202 with an invocation request ID, indicating that the client should commence polling for the result using the invocation request ID. Access to this endpoint mandates inclusion of either a bearer token or an api-key with 'invoke_function' scope in the HTTP Authorization header. Additionally, this endpoint has the capability to provide updates on the progress of the request, contingent upon the workload's provision of such information. In-progress responses are returned in order. If no in-progress response is received during polling you will receive the most recent in-progress response. Only the first 256 unread in-progress messages are kept.

post/v2/nvcf/exec/functions/{functionId}

Path parameters

functionIdstring uuid required

Request body

requestBodyobject required

Response

Invocation is fulfilled

reqIdstring uuid

Request id

status'errored' | 'in-progress' | 'fulfilled' | 'pending-evaluation' | 'rejected'

Status of the task/job executing cloud function.

responseReferencestring url

For large results, responseReference will be a pre-signeddownload URL.

percentCompleteinteger

Progress indicator for the task/job executing cloud function.

errorCodeinteger

Error code from the container while executing cloud function.

responsestring

Response/result of size < 5MB size for the task/job executing cloud function.