For the complete documentation index, see llms.txt. This page is also available as Markdown.

AI Applications

List AI applications.

get

List AI applications.

Authorizations
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[]Optional

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"]
Responses
200

ok.

application/json
nextintegerOptionalExample: 1
get/api/v1/ai-applications
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",
      "phase": "text",
      "projectId": "text",
      "projectName": "text",
      "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"
        }
      }
    }
  ]
}

Get AI application.

get

Get AI application.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
aiApplicationIdstring · uuidRequired

The unique identifier of the application.

Responses
200

ok.

application/json
idstring · uuidOptional
namestringOptional
sourcestringOptional
typestringOptional
phasestringOptional
projectIdstringOptional
projectNamestringOptional
get/api/v1/ai-applications/{aiApplicationId}
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",
  "phase": "text",
  "projectId": "text",
  "projectName": "text",
  "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"
    }
  }
}

Last updated