AI Applications

List AI applications. [Experimental]

get

List AI applications.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

verbositystring · enumOptional

response verbosity level.

Default: briefExample: fullPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

sortBystring · enumOptional

Sort results by a parameter.

Possible values:

filterBystring[] · max: 10Optional

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 >=.

Example: ["name!=some-name"]

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

ok.

application/json

nextintegerOptionalExample: 1

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/ai-applications

HTTPcURLJavaScriptPython

GET /api/v1/ai-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": 1,
  "applications": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "source": "text",
      "type": "text",
      "desiredPhase": "text",
      "phase": "text",
      "projectId": 1,
      "projectName": "project-a",
      "resources": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "kind": "text"
        }
      ],
      "allocatedResources": {
        "gpu": 1.5,
        "gpuMemory": "200Mi",
        "cpu": 0.5,
        "cpuMemory": "0B"
      },
      "requestedResources": {
        "gpu": {
          "limit": 1.5,
          "request": 1
        },
        "gpuMemory": {
          "limit": "2G",
          "request": "200M"
        },
        "cpu": {
          "limit": 1.5,
          "request": 1
        },
        "cpuMemory": {
          "limit": "2G",
          "request": "200M"
        }
      },
      "createdAt": "2026-05-14T16:23:21.204Z",
      "createdBy": "text",
      "updatedAt": "2026-05-14T16:23:21.204Z",
      "updatedBy": "text",
      "updateCount": 1,
      "actionStatus": "text",
      "actionMessage": "text",
      "endpoints": [
        {
          "host": "text",
          "port": 1,
          "path": "text",
          "tlsEnabled": true,
          "protocol": "text",
          "url": "text",
          "workloadId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "spec": {
        "chartRef": {
          "repo": "https://charts.bitnami.com/bitnami",
          "chartName": "redis",
          "chartVersion": "17.3.17",
          "chartURL": "https://helm.ngc.nvidia.com/nvidia/blueprint/charts/nvidia-blueprint-rag-v2.3.0.tgz"
        },
        "values": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "valuesBase64": "Ynl0ZXM=",
        "auth": {
          "assetId": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    }
  ]
}

Create AI application.

post

Create AI application.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

clusterIdstring · uuidRequired

The id of the cluster.

Example: 71f69d83-ba66-4822-adf5-55ce55efd210

projectIdstringRequired

The id of the project.

Example: 1Pattern: .*

namestring · max: 63Required

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.

Pattern: ^[a-z]([a-z0-9-]*[a-z0-9])?$

Responses

200

ok.

application/json

idstring · uuidOptional

namestring · max: 63Optional

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.

Pattern: ^[a-z]([a-z0-9-]*[a-z0-9])?$

sourcestringOptional

typestringOptional

desiredPhasestring · nullableOptional

The desired phase of the application.

phasestringOptional

The actual status of the release in the cluster.

projectIdstringOptional

The id of the project.

Example: 1Pattern: .*

projectNamestring · min: 1Optional

The name of the project

Example: project-aPattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$

createdAtstring · date-timeOptional

createdBystring · min: 1Optional

The user who created the application.

updatedAtstring · date-timeOptional

updatedBystring · min: 1Optional

The user who created the application.

updateCountinteger · int64Optional

The sync update counter for this application.

actionStatusstring · nullableOptional

The status of the recent action preformed on the application.

actionMessagestring · nullableOptional

The message of the recent action preformed on the application.

204

No Content.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

/api/v1/ai-applications

HTTPcURLJavaScriptPython

POST /api/v1/ai-applications HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 420

{
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "projectId": 1,
  "name": "text",
  "spec": {
    "chartRef": {
      "repo": "https://charts.bitnami.com/bitnami",
      "chartName": "redis",
      "chartVersion": "17.3.17",
      "chartURL": "https://helm.ngc.nvidia.com/nvidia/blueprint/charts/nvidia-blueprint-rag-v2.3.0.tgz"
    },
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "valuesBase64": "Ynl0ZXM=",
    "auth": {
      "assetId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "source": "text",
  "type": "text",
  "desiredPhase": "text",
  "phase": "text",
  "projectId": 1,
  "projectName": "project-a",
  "resources": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "kind": "text"
    }
  ],
  "allocatedResources": {
    "gpu": 1.5,
    "gpuMemory": "200Mi",
    "cpu": 0.5,
    "cpuMemory": "0B"
  },
  "requestedResources": {
    "gpu": {
      "limit": 1.5,
      "request": 1
    },
    "gpuMemory": {
      "limit": "2G",
      "request": "200M"
    },
    "cpu": {
      "limit": 1.5,
      "request": 1
    },
    "cpuMemory": {
      "limit": "2G",
      "request": "200M"
    }
  },
  "createdAt": "2026-05-14T16:23:21.204Z",
  "createdBy": "text",
  "updatedAt": "2026-05-14T16:23:21.204Z",
  "updatedBy": "text",
  "updateCount": 1,
  "actionStatus": "text",
  "actionMessage": "text",
  "endpoints": [
    {
      "host": "text",
      "port": 1,
      "path": "text",
      "tlsEnabled": true,
      "protocol": "text",
      "url": "text",
      "workloadId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "spec": {
    "chartRef": {
      "repo": "https://charts.bitnami.com/bitnami",
      "chartName": "redis",
      "chartVersion": "17.3.17",
      "chartURL": "https://helm.ngc.nvidia.com/nvidia/blueprint/charts/nvidia-blueprint-rag-v2.3.0.tgz"
    },
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "valuesBase64": "Ynl0ZXM=",
    "auth": {
      "assetId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Count AI applications. [Experimental]

get

Get the total number of AI applications.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[] · max: 10Optional

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 >=.

Example: ["name!=some-name"]

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

Executed successfully.

application/json

countinteger · int64RequiredExample: 1

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

/api/v1/ai-applications/count

HTTPcURLJavaScriptPython

GET /api/v1/ai-applications/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Get AI application. [Experimental]

get

Get AI application.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

aiApplicationIdstring · uuidRequired

The unique identifier of the application.

Responses

200

ok.

application/json

idstring · uuidOptional

namestring · max: 63Optional

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.

Pattern: ^[a-z]([a-z0-9-]*[a-z0-9])?$

sourcestringOptional

typestringOptional

desiredPhasestring · nullableOptional

The desired phase of the application.

phasestringOptional

The actual status of the release in the cluster.

projectIdstringOptional

The id of the project.

Example: 1Pattern: .*

projectNamestring · min: 1Optional

The name of the project

Example: project-aPattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$

createdAtstring · date-timeOptional

createdBystring · min: 1Optional

The user who created the application.

updatedAtstring · date-timeOptional

updatedBystring · min: 1Optional

The user who created the application.

updateCountinteger · int64Optional

The sync update counter for this application.

actionStatusstring · nullableOptional

The status of the recent action preformed on the application.

actionMessagestring · nullableOptional

The message of the recent action preformed on the application.

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/ai-applications/{aiApplicationId}

HTTPcURLJavaScriptPython

GET /api/v1/ai-applications/{aiApplicationId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "source": "text",
  "type": "text",
  "desiredPhase": "text",
  "phase": "text",
  "projectId": 1,
  "projectName": "project-a",
  "resources": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "kind": "text"
    }
  ],
  "allocatedResources": {
    "gpu": 1.5,
    "gpuMemory": "200Mi",
    "cpu": 0.5,
    "cpuMemory": "0B"
  },
  "requestedResources": {
    "gpu": {
      "limit": 1.5,
      "request": 1
    },
    "gpuMemory": {
      "limit": "2G",
      "request": "200M"
    },
    "cpu": {
      "limit": 1.5,
      "request": 1
    },
    "cpuMemory": {
      "limit": "2G",
      "request": "200M"
    }
  },
  "createdAt": "2026-05-14T16:23:21.204Z",
  "createdBy": "text",
  "updatedAt": "2026-05-14T16:23:21.204Z",
  "updatedBy": "text",
  "updateCount": 1,
  "actionStatus": "text",
  "actionMessage": "text",
  "endpoints": [
    {
      "host": "text",
      "port": 1,
      "path": "text",
      "tlsEnabled": true,
      "protocol": "text",
      "url": "text",
      "workloadId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "spec": {
    "chartRef": {
      "repo": "https://charts.bitnami.com/bitnami",
      "chartName": "redis",
      "chartVersion": "17.3.17",
      "chartURL": "https://helm.ngc.nvidia.com/nvidia/blueprint/charts/nvidia-blueprint-rag-v2.3.0.tgz"
    },
    "values": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "valuesBase64": "Ynl0ZXM=",
    "auth": {
      "assetId": "123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Delete AI application.

delete

Delete AI application.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

aiApplicationIdstring · uuidRequired

The unique identifier of the application.

Responses

202

Accepted.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

delete

/api/v1/ai-applications/{aiApplicationId}

HTTPcURLJavaScriptPython

DELETE /api/v1/ai-applications/{aiApplicationId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "code": 202,
  "message": "Request has been accepted."
}