LogoLogo
Go ToJoin the Community
  • Getting Started
    • Introduction
    • How it Works
    • Onboarding
  • Examples
    • Tutorials
      • Hello, World!
      • Image Generation w/ Stable Diffusion
  • CREATE WITH BYTENITE
    • Building Blocks
      • Apps
      • Job Templates
  • SDK
    • ByteNite Dev CLI
  • Launch with ByteNite
    • Data Sources
      • AWS S3
      • Google Cloud Storage
      • Storj
      • HTTP
      • File Upload
      • Temporary Bucket
    • Jobs
  • API Reference
    • Customer API
      • Jobs
        • Create
        • Read
        • Update
        • Manage
        • Other
      • Logs
      • Data Sources
      • Templates
      • Events
    • Authentication API
      • Access Token
      • API Keys
      • Secrets
      • User
    • Developer API
      • Apps
        • Metadata
        • Push
        • Manage
        • Pull
      • Engines
        • Metadata
        • Push
        • Manage
        • Pull
      • Templates
    • Wallet API
      • Balance
      • Transactions
      • Exchange Rate
      • Redeem Coupon
  • GUI
  • Other
    • Glossary
    • Feature Requests
    • Status
Powered by GitBook

ยฉ 2025 ByteNite Inc.

On this page

Was this helpful?

Export as PDF
  1. API Reference
  2. Developer API
  3. Engines

Metadata

PreviousEnginesNextPush

Last updated 26 days ago

Was this helpful?




Get engines

get

List all engines owned by the user

Authorizations
Query parameters
orderByanyOptional

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

pagination.limitanyOptional

Number of rows to return per page.

pagination.offsetanyOptional

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

Responses
200
A successful response.
400
Returned when the users sends a malformed request.
401
Returned when the user is not authenticated.
403
Returned when the user does not have permission to access the resource.
404
Returned when the resource does not exist.
500
Returned when an error on the server occurred.
503
Returned when the resource is temporarily unavailable.
default
An unexpected error response.
get
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-05-24T12:27:42.314Z",
      "updatedAt": "2025-05-24T12:27:42.314Z",
      "deletedAt": "2025-05-24T12:27:42.314Z",
      "platform": "text",
      "platformConfig": {
        "container": "python:latest",
        "privateImage": true,
        "username": "text",
        "token": "text"
      },
      "deviceRequirements": {
        "minCpu": 1,
        "minMemory": 2
      }
    }
  ]
}

Get status of engine

get

Get status of engine

Authorizations
Path parameters
engineTaganyRequired
Query parameters
engineIdanyOptional
engineDataanyOptional
engineLinkanyOptional
engineStatusanyOptional
Responses
200
A successful response.
400
Returned when the users sends a malformed request.
401
Returned when the user is not authenticated.
403
Returned when the user does not have permission to access the resource.
404
Returned when the resource does not exist.
500
Returned when an error on the server occurred.
503
Returned when the resource is temporarily unavailable.
default
An unexpected error response.
get
GET /v1/dev/engines/{engineTag}/status HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "engineId": "text",
  "engineTag": "text",
  "engineData": "Ynl0ZXM=",
  "engineLink": "text",
  "engineStatus": "text"
}
  • GETGet engines
  • GETGet status of engine