AI Applications
Bearer authentication
response verbosity level.
briefExample: fullPossible values: The offset of the first item returned in the collection.
100The maximum number of entries to return.
50Sort results in descending or ascending order.
ascPossible values: Sort results by a parameter.
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 >=.
["name!=some-name"]Filter results by a free text search.
test projectok.
1Bad request.
Unauthorized
Forbidden
unexpected error
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-01-01T00:00:00.000Z",
"createdBy": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"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"
}
}
}
]
}Bearer authentication
The id of the cluster.
71f69d83-ba66-4822-adf5-55ce55efd210The id of the project.
1Pattern: .*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.
^[a-z]([a-z0-9-]*[a-z0-9])?$ok.
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.
^[a-z]([a-z0-9-]*[a-z0-9])?$The desired phase of the application.
The actual status of the release in the cluster.
The id of the project.
1Pattern: .*The name of the project
project-aPattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$The user who created the application.
The user who created the application.
The sync update counter for this application.
The status of the recent action preformed on the application.
The message of the recent action preformed on the application.
No Content.
Bad request.
Unauthorized
Forbidden
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-01-01T00:00:00.000Z",
"createdBy": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"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"
}
}
}Bearer authentication
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 >=.
["name!=some-name"]Filter results by a free text search.
test projectExecuted successfully.
1Bad request.
Unauthorized
Forbidden
unexpected error
unexpected error
GET /api/v1/ai-applications/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"count": 1
}Bearer authentication
The unique identifier of the application.
ok.
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.
^[a-z]([a-z0-9-]*[a-z0-9])?$The desired phase of the application.
The actual status of the release in the cluster.
The id of the project.
1Pattern: .*The name of the project
project-aPattern: ^[a-z0-9]([a-z0-9-]*[a-z0-9])?$The user who created the application.
The user who created the application.
The sync update counter for this application.
The status of the recent action preformed on the application.
The message of the recent action preformed on the application.
Bad request.
Unauthorized
Forbidden
unexpected error
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-01-01T00:00:00.000Z",
"createdBy": "text",
"updatedAt": "2026-01-01T00:00:00.000Z",
"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"
}
}
}Bearer authentication
The unique identifier of the application.
Accepted.
Bad request.
Unauthorized
Forbidden
The specified resource was not found
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."
}Last updated