v1

latestOpenAPI 3.0.1raw.githubusercontent.com2024-10-113944112.8 KB
Function Management

Create Function

Creates a new function within the authenticated NVIDIA Cloud Account. Requires a bearer token with 'register_function' scope in the HTTP Authorization header.

post/v2/nvcf/functions

Request body

namestring required

Function name must start with lowercase/uppercase/digit and can only contain lowercase, uppercase, digit, hyphen, and underscore characters

inferenceUrlstring uri required

Entrypoint for invoking the container to process a request

healthUristring uri

Health endpoint for the container or the helmChart

inferencePortinteger

Optional port number where the inference listener is running. Defaults to 8000 for Triton.

containerArgsstring

Args to be passed when launching the container

containerImagestring uri

Optional custom container image

helmChartstring uri

Optional Helm Chart

helmChartServiceNamestring

Helm Chart Service Name is required when helmChart property is specified

apiBodyFormat'PREDICT_V2' | 'CUSTOM'

Invocation request body format

tagsstring[]

Optional set of tags - could be empty. Provided by user

descriptionstring

Optional function/version description

functionType'DEFAULT' | 'STREAMING'

Optional function type, used to indicate a STREAMING function. Defaults to DEFAULT.

Example request

{
  "health": {
    "timeout": "PT10S"
  }
}

Response

OK

Example response

{
  "function": {
    "health": {
      "timeout": "PT10S"
    }
  }
}