v1

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

Poll For Result Using Function Invocation Request

Retrieves the status of an in-progress or pending request using its unique invocation request ID. If the result is available, it will be included in the response, marking the request as fulfilled. Conversely, if the result is not yet available, the request is deemed pending. Access to this endpoint mandates inclusion of either a bearer token or an api-key with 'invoke_function' scope in the HTTP Authorization header. 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.

get/v2/nvcf/exec/status/{requestId}

Path parameters

requestIdstring uuid required

Function invocation request id

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.