# AI Applications

## List AI applications. \[Experimental]

> List AI applications.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"AI Applications-API"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"ApplicationQueryVerbosity":{"name":"verbosity","in":"query","required":false,"description":"response verbosity level.","schema":{"$ref":"#/components/schemas/AIApplicationVerbosity"}},"Offset":{"name":"offset","in":"query","required":false,"description":"The offset of the first item returned in the collection.","schema":{"type":"integer","format":"int32"}},"Limit":{"name":"limit","in":"query","required":false,"description":"The maximum number of entries to return.","schema":{"type":"integer","format":"int32","default":50,"minimum":1,"maximum":500}},"SortOrder":{"name":"sortOrder","in":"query","required":false,"description":"Sort results in descending or ascending order.","schema":{"type":"string","enum":["asc","desc"],"default":"asc"}},"ApplicationsSort":{"name":"sortBy","in":"query","required":false,"description":"Sort results by a parameter.","schema":{"$ref":"#/components/schemas/AIApplicationsSortFilterFields"}},"ApplicationsFilter":{"name":"filterBy","in":"query","required":false,"description":"Filter results by a parameter. Use the format field-name operator value. Operators are `==` Equals, `!=` Not equals, `<=` Less than or equal, `>=` Greater than or equal, `=@` contains, `!@` Does not contain, `=^` Starts with and `=$` Ends with. Dates are in ISO 8601 timestamp format and available for operators `==`, `!=`, `<=` and `>=`.","schema":{"type":"array","maxItems":10,"items":{"type":"string","pattern":"^(clusterId|name|projectId|projectName|source|type|createdAt)(==|!=|<=|>=|=@|!@|=\\^|=\\$).+$"}},"explode":false},"Search":{"name":"search","in":"query","required":false,"description":"Filter results by a free text search.","schema":{"type":"string"}}},"schemas":{"AIApplicationVerbosity":{"type":"string","enum":["brief","full"],"default":"brief"},"AIApplicationsSortFilterFields":{"type":"string","enum":["clusterId","name","projectId","projectName","source","type","createdAt"]},"AIApplications":{"type":"array","items":{"$ref":"#/components/schemas/AIApplication"}},"AIApplication":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"$ref":"#/components/schemas/AIApplicationName"},"source":{"type":"string"},"type":{"type":"string"},"desiredPhase":{"type":"string","description":"The desired phase of the application.","nullable":true},"phase":{"type":"string","description":"The actual status of the release in the cluster."},"projectId":{"$ref":"#/components/schemas/ProjectId"},"projectName":{"$ref":"#/components/schemas/ProjectName"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/AIApplicationResource"}},"allocatedResources":{"$ref":"#/components/schemas/AIApplicationAllocatedResources"},"requestedResources":{"$ref":"#/components/schemas/AIApplicationRequestResources"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"description":"The user who created the application.","type":"string","minLength":1},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"description":"The user who created the application.","type":"string","minLength":1},"updateCount":{"type":"integer","format":"int64","description":"The sync update counter for this application."},"actionStatus":{"type":"string","description":"The status of the recent action preformed on the application.","nullable":true},"actionMessage":{"type":"string","description":"The message of the recent action preformed on the application.","nullable":true},"endpoints":{"description":"List of network endpoints through which the workloads associated with the AI application is exposed.","type":"array","items":{"$ref":"#/components/schemas/AiApplicationEndpoint"}},"spec":{"$ref":"#/components/schemas/AIApplicationSpec","nullable":true}}},"AIApplicationName":{"type":"string","description":"The name of the application. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start with a letter.","maxLength":63,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$"},"ProjectId":{"description":"The id of the project.","type":"string","pattern":".*"},"ProjectName":{"type":"string","description":"The name of the project","minLength":1,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"},"AIApplicationResource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string"}}},"AIApplicationAllocatedResources":{"type":"object","nullable":true,"properties":{"gpu":{"type":"number","nullable":true,"format":"double","description":"States the number of GPUs allocated for the created workloads."},"gpuMemory":{"type":"string","pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$","nullable":true},"cpu":{"type":"number","nullable":true,"format":"double","description":"States the amount of CPU cores used by the workloads running."},"cpuMemory":{"type":"string","pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$","nullable":true}}},"AIApplicationRequestResources":{"type":"object","nullable":true,"properties":{"gpu":{"$ref":"#/components/schemas/RequestResourceCores"},"gpuMemory":{"$ref":"#/components/schemas/RequestResourceQuantity"},"cpu":{"$ref":"#/components/schemas/RequestResourceCores"},"cpuMemory":{"$ref":"#/components/schemas/RequestResourceQuantity"}}},"RequestResourceCores":{"type":"object","properties":{"limit":{"type":"number","nullable":true,"format":"double"},"request":{"type":"number","nullable":true,"format":"double"}},"nullable":true},"RequestResourceQuantity":{"type":"object","properties":{"limit":{"type":"string","nullable":true,"pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"},"request":{"type":"string","nullable":true,"pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"}},"nullable":true},"AiApplicationEndpoint":{"allOf":[{"$ref":"#/components/schemas/Endpoint"},{"type":"object","properties":{"workloadId":{"description":"The id of the workload associated with this endpoint.","type":"string","format":"uuid"}}}]},"Endpoint":{"type":"object","properties":{"host":{"type":"string","description":"The hostname used to access the endpoint (for example, chat.example.com). This value is typically defined by the exposing Kubernetes resource (such as an Ingress)."},"port":{"type":"integer","description":"The network port exposed by the endpoint. This is the port used when connecting to the workload."},"path":{"type":"string","description":"The URL path associated with the endpoint (for example, /v1/completions). Combined with host, it forms the full HTTP route to the workload."},"tlsEnabled":{"type":"boolean","nullable":true,"description":"Indicates whether TLS is enabled for the endpoint. When true, the endpoint expects encrypted connections (typically HTTPS)."},"protocol":{"type":"string","description":"The network protocol used for communication with the endpoint (for example, HTTP or HTTPS)."},"url":{"type":"string","description":"The fully qualified URL through which the workload is accessible. This value represents the complete access address derived from the protocol, host, and path (for example, https://chat.example.com/v1/completions)."}}},"AIApplicationSpec":{"type":"object","required":["chartRef"],"properties":{"chartRef":{"$ref":"#/components/schemas/AIApplicationSpecChartRef"},"values":{"type":"object","description":"Inline Helm values used to override the Helm chart’s default configuration. These values are merged with the Helm chart’s `values.yaml`. This field is mutually exclusive with `valuesBase64`.","additionalProperties":true},"valuesBase64":{"type":"string","description":"Base64-encoded Helm values used to override the Helm chart’s default configuration. This field is mutually exclusive with `values`.","format":"byte"},"auth":{"$ref":"#/components/schemas/AIApplicationAuth"}}},"AIApplicationSpecChartRef":{"type":"object","description":"Specifies the origin of the Helm chart. Provide by referencing a connected Helm repository (`repo` + `name` + `version`) or by providing a direct chart URL.","properties":{"repo":{"$ref":"#/components/schemas/AIApplicationChartRepo"},"chartName":{"$ref":"#/components/schemas/AIApplicationChartName"},"chartVersion":{"$ref":"#/components/schemas/AIApplicationChartVersion"},"chartURL":{"$ref":"#/components/schemas/AIApplicationChartUrl"}}},"AIApplicationChartRepo":{"type":"string","description":"The HTTP or HTTPS URL of the Helm repository that hosts the chart. This must match a repository that is accessible. Used together with `name` and `version`.","maxLength":250},"AIApplicationChartName":{"type":"string","description":"The name of the chart within the specified repository. This corresponds to the chart’s directory name.","maxLength":250},"AIApplicationChartVersion":{"type":"string","description":"The specific Semantic Version (SemVer) of the chart to deploy.","maxLength":50},"AIApplicationChartUrl":{"type":"string","description":"A direct HTTPS URL to a packaged Helm chart archive (.tgz). When provided, the chart is downloaded directly from this location instead of being resolved through a Helm repository reference.","maxLength":250},"AIApplicationAuth":{"type":"object","description":"Authentication configuration required to access a private Helm repository or chart URL. This is used when the chart source requires credentials.","properties":{"assetId":{"type":"string","description":"The ID of the asset to use for authentication.","format":"uuid"}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/ai-applications":{"get":{"summary":"List AI applications. [Experimental]","description":"List AI applications.","operationId":"list_applications","tags":["AI Applications-API"],"parameters":[{"$ref":"#/components/parameters/ApplicationQueryVerbosity"},{"$ref":"#/components/parameters/Offset"},{"$ref":"#/components/parameters/Limit"},{"$ref":"#/components/parameters/SortOrder"},{"$ref":"#/components/parameters/ApplicationsSort"},{"$ref":"#/components/parameters/ApplicationsFilter"},{"$ref":"#/components/parameters/Search"}],"responses":{"200":{"description":"ok.","content":{"application/json":{"schema":{"type":"object","required":["applications"],"properties":{"next":{"type":"integer"},"applications":{"$ref":"#/components/schemas/AIApplications"}}}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Create AI application.

> Create AI application.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"AI Applications-API"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"schemas":{"AIApplicationCreationRequest":{"type":"object","required":["clusterId","projectId","name","spec"],"properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId"},"projectId":{"$ref":"#/components/schemas/ProjectId"},"name":{"$ref":"#/components/schemas/AIApplicationName"},"spec":{"$ref":"#/components/schemas/AIApplicationSpec"}}},"ClusterId":{"description":"The id of the cluster.","type":"string","format":"uuid"},"ProjectId":{"description":"The id of the project.","type":"string","pattern":".*"},"AIApplicationName":{"type":"string","description":"The name of the application. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start with a letter.","maxLength":63,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$"},"AIApplicationSpec":{"type":"object","required":["chartRef"],"properties":{"chartRef":{"$ref":"#/components/schemas/AIApplicationSpecChartRef"},"values":{"type":"object","description":"Inline Helm values used to override the Helm chart’s default configuration. These values are merged with the Helm chart’s `values.yaml`. This field is mutually exclusive with `valuesBase64`.","additionalProperties":true},"valuesBase64":{"type":"string","description":"Base64-encoded Helm values used to override the Helm chart’s default configuration. This field is mutually exclusive with `values`.","format":"byte"},"auth":{"$ref":"#/components/schemas/AIApplicationAuth"}}},"AIApplicationSpecChartRef":{"type":"object","description":"Specifies the origin of the Helm chart. Provide by referencing a connected Helm repository (`repo` + `name` + `version`) or by providing a direct chart URL.","properties":{"repo":{"$ref":"#/components/schemas/AIApplicationChartRepo"},"chartName":{"$ref":"#/components/schemas/AIApplicationChartName"},"chartVersion":{"$ref":"#/components/schemas/AIApplicationChartVersion"},"chartURL":{"$ref":"#/components/schemas/AIApplicationChartUrl"}}},"AIApplicationChartRepo":{"type":"string","description":"The HTTP or HTTPS URL of the Helm repository that hosts the chart. This must match a repository that is accessible. Used together with `name` and `version`.","maxLength":250},"AIApplicationChartName":{"type":"string","description":"The name of the chart within the specified repository. This corresponds to the chart’s directory name.","maxLength":250},"AIApplicationChartVersion":{"type":"string","description":"The specific Semantic Version (SemVer) of the chart to deploy.","maxLength":50},"AIApplicationChartUrl":{"type":"string","description":"A direct HTTPS URL to a packaged Helm chart archive (.tgz). When provided, the chart is downloaded directly from this location instead of being resolved through a Helm repository reference.","maxLength":250},"AIApplicationAuth":{"type":"object","description":"Authentication configuration required to access a private Helm repository or chart URL. This is used when the chart source requires credentials.","properties":{"assetId":{"type":"string","description":"The ID of the asset to use for authentication.","format":"uuid"}}},"AIApplication":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"$ref":"#/components/schemas/AIApplicationName"},"source":{"type":"string"},"type":{"type":"string"},"desiredPhase":{"type":"string","description":"The desired phase of the application.","nullable":true},"phase":{"type":"string","description":"The actual status of the release in the cluster."},"projectId":{"$ref":"#/components/schemas/ProjectId"},"projectName":{"$ref":"#/components/schemas/ProjectName"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/AIApplicationResource"}},"allocatedResources":{"$ref":"#/components/schemas/AIApplicationAllocatedResources"},"requestedResources":{"$ref":"#/components/schemas/AIApplicationRequestResources"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"description":"The user who created the application.","type":"string","minLength":1},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"description":"The user who created the application.","type":"string","minLength":1},"updateCount":{"type":"integer","format":"int64","description":"The sync update counter for this application."},"actionStatus":{"type":"string","description":"The status of the recent action preformed on the application.","nullable":true},"actionMessage":{"type":"string","description":"The message of the recent action preformed on the application.","nullable":true},"endpoints":{"description":"List of network endpoints through which the workloads associated with the AI application is exposed.","type":"array","items":{"$ref":"#/components/schemas/AiApplicationEndpoint"}},"spec":{"$ref":"#/components/schemas/AIApplicationSpec","nullable":true}}},"ProjectName":{"type":"string","description":"The name of the project","minLength":1,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"},"AIApplicationResource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string"}}},"AIApplicationAllocatedResources":{"type":"object","nullable":true,"properties":{"gpu":{"type":"number","nullable":true,"format":"double","description":"States the number of GPUs allocated for the created workloads."},"gpuMemory":{"type":"string","pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$","nullable":true},"cpu":{"type":"number","nullable":true,"format":"double","description":"States the amount of CPU cores used by the workloads running."},"cpuMemory":{"type":"string","pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$","nullable":true}}},"AIApplicationRequestResources":{"type":"object","nullable":true,"properties":{"gpu":{"$ref":"#/components/schemas/RequestResourceCores"},"gpuMemory":{"$ref":"#/components/schemas/RequestResourceQuantity"},"cpu":{"$ref":"#/components/schemas/RequestResourceCores"},"cpuMemory":{"$ref":"#/components/schemas/RequestResourceQuantity"}}},"RequestResourceCores":{"type":"object","properties":{"limit":{"type":"number","nullable":true,"format":"double"},"request":{"type":"number","nullable":true,"format":"double"}},"nullable":true},"RequestResourceQuantity":{"type":"object","properties":{"limit":{"type":"string","nullable":true,"pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"},"request":{"type":"string","nullable":true,"pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"}},"nullable":true},"AiApplicationEndpoint":{"allOf":[{"$ref":"#/components/schemas/Endpoint"},{"type":"object","properties":{"workloadId":{"description":"The id of the workload associated with this endpoint.","type":"string","format":"uuid"}}}]},"Endpoint":{"type":"object","properties":{"host":{"type":"string","description":"The hostname used to access the endpoint (for example, chat.example.com). This value is typically defined by the exposing Kubernetes resource (such as an Ingress)."},"port":{"type":"integer","description":"The network port exposed by the endpoint. This is the port used when connecting to the workload."},"path":{"type":"string","description":"The URL path associated with the endpoint (for example, /v1/completions). Combined with host, it forms the full HTTP route to the workload."},"tlsEnabled":{"type":"boolean","nullable":true,"description":"Indicates whether TLS is enabled for the endpoint. When true, the endpoint expects encrypted connections (typically HTTPS)."},"protocol":{"type":"string","description":"The network protocol used for communication with the endpoint (for example, HTTP or HTTPS)."},"url":{"type":"string","description":"The fully qualified URL through which the workload is accessible. This value represents the complete access address derived from the protocol, host, and path (for example, https://chat.example.com/v1/completions)."}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"204NoContent":{"description":"No Content."},"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/ai-applications":{"post":{"summary":"Create AI application.","description":"Create AI application.","operationId":"create_application1","tags":["AI Applications-API"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIApplicationCreationRequest"}}}},"responses":{"200":{"description":"ok.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIApplication"}}}},"204":{"$ref":"#/components/responses/204NoContent"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"}}}}}}
```

## Count AI applications. \[Experimental]

> Get the total number of AI applications.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"AI Applications-API"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"ApplicationsFilter":{"name":"filterBy","in":"query","required":false,"description":"Filter results by a parameter. Use the format field-name operator value. Operators are `==` Equals, `!=` Not equals, `<=` Less than or equal, `>=` Greater than or equal, `=@` contains, `!@` Does not contain, `=^` Starts with and `=$` Ends with. Dates are in ISO 8601 timestamp format and available for operators `==`, `!=`, `<=` and `>=`.","schema":{"type":"array","maxItems":10,"items":{"type":"string","pattern":"^(clusterId|name|projectId|projectName|source|type|createdAt)(==|!=|<=|>=|=@|!@|=\\^|=\\$).+$"}},"explode":false},"Search":{"name":"search","in":"query","required":false,"description":"Filter results by a free text search.","schema":{"type":"string"}}},"schemas":{"CountResponse":{"type":"object","required":["count"],"properties":{"count":{"type":"integer","format":"int64"}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500InternalServerError":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/ai-applications/count":{"get":{"summary":"Count AI applications. [Experimental]","description":"Get the total number of AI applications.","operationId":"count_applications","tags":["AI Applications-API"],"parameters":[{"$ref":"#/components/parameters/ApplicationsFilter"},{"$ref":"#/components/parameters/Search"}],"responses":{"200":{"description":"Executed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountResponse"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"500":{"$ref":"#/components/responses/500InternalServerError"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Get AI application. \[Experimental]

> Get AI application.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"AI Applications-API"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"ApplicationId":{"name":"aiApplicationId","in":"path","required":true,"description":"The unique identifier of the application.","schema":{"type":"string","format":"uuid"}}},"schemas":{"AIApplication":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"$ref":"#/components/schemas/AIApplicationName"},"source":{"type":"string"},"type":{"type":"string"},"desiredPhase":{"type":"string","description":"The desired phase of the application.","nullable":true},"phase":{"type":"string","description":"The actual status of the release in the cluster."},"projectId":{"$ref":"#/components/schemas/ProjectId"},"projectName":{"$ref":"#/components/schemas/ProjectName"},"resources":{"type":"array","items":{"$ref":"#/components/schemas/AIApplicationResource"}},"allocatedResources":{"$ref":"#/components/schemas/AIApplicationAllocatedResources"},"requestedResources":{"$ref":"#/components/schemas/AIApplicationRequestResources"},"createdAt":{"type":"string","format":"date-time"},"createdBy":{"description":"The user who created the application.","type":"string","minLength":1},"updatedAt":{"type":"string","format":"date-time"},"updatedBy":{"description":"The user who created the application.","type":"string","minLength":1},"updateCount":{"type":"integer","format":"int64","description":"The sync update counter for this application."},"actionStatus":{"type":"string","description":"The status of the recent action preformed on the application.","nullable":true},"actionMessage":{"type":"string","description":"The message of the recent action preformed on the application.","nullable":true},"endpoints":{"description":"List of network endpoints through which the workloads associated with the AI application is exposed.","type":"array","items":{"$ref":"#/components/schemas/AiApplicationEndpoint"}},"spec":{"$ref":"#/components/schemas/AIApplicationSpec","nullable":true}}},"AIApplicationName":{"type":"string","description":"The name of the application. The name must be unique within the organization and can only contain lowercase alphanumeric characters and hyphens. It must start with a letter.","maxLength":63,"pattern":"^[a-z]([a-z0-9-]*[a-z0-9])?$"},"ProjectId":{"description":"The id of the project.","type":"string","pattern":".*"},"ProjectName":{"type":"string","description":"The name of the project","minLength":1,"pattern":"^[a-z0-9]([a-z0-9-]*[a-z0-9])?$"},"AIApplicationResource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"kind":{"type":"string"}}},"AIApplicationAllocatedResources":{"type":"object","nullable":true,"properties":{"gpu":{"type":"number","nullable":true,"format":"double","description":"States the number of GPUs allocated for the created workloads."},"gpuMemory":{"type":"string","pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$","nullable":true},"cpu":{"type":"number","nullable":true,"format":"double","description":"States the amount of CPU cores used by the workloads running."},"cpuMemory":{"type":"string","pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$","nullable":true}}},"AIApplicationRequestResources":{"type":"object","nullable":true,"properties":{"gpu":{"$ref":"#/components/schemas/RequestResourceCores"},"gpuMemory":{"$ref":"#/components/schemas/RequestResourceQuantity"},"cpu":{"$ref":"#/components/schemas/RequestResourceCores"},"cpuMemory":{"$ref":"#/components/schemas/RequestResourceQuantity"}}},"RequestResourceCores":{"type":"object","properties":{"limit":{"type":"number","nullable":true,"format":"double"},"request":{"type":"number","nullable":true,"format":"double"}},"nullable":true},"RequestResourceQuantity":{"type":"object","properties":{"limit":{"type":"string","nullable":true,"pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"},"request":{"type":"string","nullable":true,"pattern":"^([+-]?[0-9.]+)([eEinumkKMGTP]*[-+]?[0-9]*)$"}},"nullable":true},"AiApplicationEndpoint":{"allOf":[{"$ref":"#/components/schemas/Endpoint"},{"type":"object","properties":{"workloadId":{"description":"The id of the workload associated with this endpoint.","type":"string","format":"uuid"}}}]},"Endpoint":{"type":"object","properties":{"host":{"type":"string","description":"The hostname used to access the endpoint (for example, chat.example.com). This value is typically defined by the exposing Kubernetes resource (such as an Ingress)."},"port":{"type":"integer","description":"The network port exposed by the endpoint. This is the port used when connecting to the workload."},"path":{"type":"string","description":"The URL path associated with the endpoint (for example, /v1/completions). Combined with host, it forms the full HTTP route to the workload."},"tlsEnabled":{"type":"boolean","nullable":true,"description":"Indicates whether TLS is enabled for the endpoint. When true, the endpoint expects encrypted connections (typically HTTPS)."},"protocol":{"type":"string","description":"The network protocol used for communication with the endpoint (for example, HTTP or HTTPS)."},"url":{"type":"string","description":"The fully qualified URL through which the workload is accessible. This value represents the complete access address derived from the protocol, host, and path (for example, https://chat.example.com/v1/completions)."}}},"AIApplicationSpec":{"type":"object","required":["chartRef"],"properties":{"chartRef":{"$ref":"#/components/schemas/AIApplicationSpecChartRef"},"values":{"type":"object","description":"Inline Helm values used to override the Helm chart’s default configuration. These values are merged with the Helm chart’s `values.yaml`. This field is mutually exclusive with `valuesBase64`.","additionalProperties":true},"valuesBase64":{"type":"string","description":"Base64-encoded Helm values used to override the Helm chart’s default configuration. This field is mutually exclusive with `values`.","format":"byte"},"auth":{"$ref":"#/components/schemas/AIApplicationAuth"}}},"AIApplicationSpecChartRef":{"type":"object","description":"Specifies the origin of the Helm chart. Provide by referencing a connected Helm repository (`repo` + `name` + `version`) or by providing a direct chart URL.","properties":{"repo":{"$ref":"#/components/schemas/AIApplicationChartRepo"},"chartName":{"$ref":"#/components/schemas/AIApplicationChartName"},"chartVersion":{"$ref":"#/components/schemas/AIApplicationChartVersion"},"chartURL":{"$ref":"#/components/schemas/AIApplicationChartUrl"}}},"AIApplicationChartRepo":{"type":"string","description":"The HTTP or HTTPS URL of the Helm repository that hosts the chart. This must match a repository that is accessible. Used together with `name` and `version`.","maxLength":250},"AIApplicationChartName":{"type":"string","description":"The name of the chart within the specified repository. This corresponds to the chart’s directory name.","maxLength":250},"AIApplicationChartVersion":{"type":"string","description":"The specific Semantic Version (SemVer) of the chart to deploy.","maxLength":50},"AIApplicationChartUrl":{"type":"string","description":"A direct HTTPS URL to a packaged Helm chart archive (.tgz). When provided, the chart is downloaded directly from this location instead of being resolved through a Helm repository reference.","maxLength":250},"AIApplicationAuth":{"type":"object","description":"Authentication configuration required to access a private Helm repository or chart URL. This is used when the chart source requires credentials.","properties":{"assetId":{"type":"string","description":"The ID of the asset to use for authentication.","format":"uuid"}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}},"responses":{"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503ServiceUnavailable":{"description":"unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/api/v1/ai-applications/{aiApplicationId}":{"get":{"summary":"Get AI application. [Experimental]","description":"Get AI application.","operationId":"get_application","tags":["AI Applications-API"],"parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"200":{"description":"ok.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AIApplication"}}}},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"503":{"$ref":"#/components/responses/503ServiceUnavailable"}}}}}}
```

## Delete AI application.

> Delete AI application.

```json
{"openapi":"3.0.3","info":{"title":"NVIDIA Run:ai","version":"2.25"},"tags":[{"name":"AI Applications-API"}],"servers":[{"url":"https://app.run.ai"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Bearer authentication"}},"parameters":{"ApplicationId":{"name":"aiApplicationId","in":"path","required":true,"description":"The unique identifier of the application.","schema":{"type":"string","format":"uuid"}}},"responses":{"202Accepted":{"description":"Accepted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpResponse"}}}},"400BadRequest":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403Forbidden":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"HttpResponse":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"}}},"Error":{"required":["code","message"],"properties":{"code":{"type":"integer","minimum":100,"maximum":599},"message":{"type":"string"},"details":{"type":"string"}}}}},"paths":{"/api/v1/ai-applications/{aiApplicationId}":{"delete":{"summary":"Delete AI application.","description":"Delete AI application.","operationId":"delete_application","tags":["AI Applications-API"],"parameters":[{"$ref":"#/components/parameters/ApplicationId"}],"responses":{"202":{"$ref":"#/components/responses/202Accepted"},"400":{"$ref":"#/components/responses/400BadRequest"},"401":{"$ref":"#/components/responses/401Unauthorized"},"403":{"$ref":"#/components/responses/403Forbidden"},"404":{"$ref":"#/components/responses/404NotFound"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://run-ai-docs.nvidia.com/api/2.25/ai-applications/ai-applications.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.