Metadata

---

Get engines

get

List all engines owned by the user

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Query parameters

orderBystringOptional

Field name to sort apps by (e.g., createdAt).

pagination.limitinteger · int64Optional

Number of rows to return per page.

pagination.offsetinteger · int64Optional

Number of rows to skip before starting to collect the result set.

isPublicbooleanOptional

Filter public engines only

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

get

/engines

HTTPcURLJavaScriptPython

GET /v1/dev/engines HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "engines": [
    {
      "id": "text",
      "name": "text",
      "version": "text",
      "owner": "text",
      "type": "text",
      "status": "text",
      "description": "text",
      "hash": "text",
      "link": "text",
      "entrypoint": "text",
      "revision": 1,
      "createdAt": "2025-12-20T07:04:14.447Z",
      "updatedAt": "2025-12-20T07:04:14.447Z",
      "deletedAt": "2025-12-20T07:04:14.447Z",
      "platform": "text",
      "platformConfig": {
        "container": "python:latest",
        "privateImage": true,
        "username": "text",
        "token": "text",
        "secrets": [
          "text"
        ]
      },
      "deviceRequirements": {
        "minCpu": 1,
        "minMemory": 2,
        "gpu": [
          "tesla t4",
          "nvidia a100-sxm4-40gb"
        ]
      },
      "isPublic": true,
      "userName": "alice"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  }
}

---

Get an engine

get

Get an engine by tag

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

engineTagstringRequired

Query parameters

engineIdstringOptional

engineDatastringOptional

engineLinkstringOptional

engineStatusstringOptional

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

get

/engines/{engineTag}

HTTPcURLJavaScriptPython

GET /v1/dev/engines/{engineTag} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "version": "text",
  "owner": "text",
  "type": "text",
  "status": "text",
  "description": "text",
  "hash": "text",
  "link": "text",
  "entrypoint": "text",
  "revision": 1,
  "createdAt": "2025-12-20T07:04:14.447Z",
  "updatedAt": "2025-12-20T07:04:14.447Z",
  "deletedAt": "2025-12-20T07:04:14.447Z",
  "platform": "text",
  "platformConfig": {
    "container": "python:latest",
    "privateImage": true,
    "username": "text",
    "token": "text",
    "secrets": [
      "text"
    ]
  },
  "deviceRequirements": {
    "minCpu": 1,
    "minMemory": 2,
    "gpu": [
      "tesla t4",
      "nvidia a100-sxm4-40gb"
    ]
  },
  "isPublic": true,
  "userName": "alice"
}

---

Get status of engine

get

Get status of engine

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

engineTagstringRequired

Query parameters

engineIdstringOptional

engineDatastringOptional

engineLinkstringOptional

engineStatusstringOptional

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

get

/engines/{engineTag}/status

HTTPcURLJavaScriptPython

GET /v1/dev/engines/{engineTag}/status HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "engineId": "text",
  "engineTag": "text",
  "engineData": "text",
  "engineLink": "text",
  "engineStatus": "text"
}