COconductorone
Function

Invoke

Changed on

Invoke executes a function at a specific commit with the provided input data.

post/api/v1/functions/{function_id}/invoke

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/functions/{function_id}/invoke
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

function_idstring required

The ID of the function to invoke.

Request body

commitIdstring

The commit ID specifying which version of the function code to run.

jsonstring base64 nullable

The JSON-encoded input data passed to the function. This field is part of the arg oneof. See the documentation for c1.api.functions.v1.FunctionsServiceInvokeRequest for more details.

vfsIdstring

Optional VFS volume ID to attach to this invocation. If empty, VFS operations will error.

Response

Successful response

invocationIdstring

The ID of the created invocation, used to track execution status and retrieve results.

jsonstring base64 nullable

Deprecated. The JSON-encoded output returned by the function. This field is part of the resp oneof. See the documentation for c1.api.functions.v1.FunctionsServiceInvokeResponse for more details.

Changes