Templates

---

Upload a template

post

Upload a template to the server

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Body

application/jsonapplication/x-protobuf

The templates specific to each app are stored in this table.

idstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

isPublicbooleanOptional

partitionerstringOptional

assemblerstringOptional

userNamestringOptional

User name of the template owner.

Example: alice

descriptionstringOptional

appstringOptional

ownerstringOptional

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

post

/templates

HTTPcURLJavaScriptPython

POST /v1/dev/templates HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 562

{
  "id": "text",
  "createdAt": "2025-12-18T04:03:13.263Z",
  "updatedAt": "2025-12-18T04:03:13.263Z",
  "isPublic": true,
  "partitioner": "text",
  "assembler": "text",
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "dataDestination": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "params": {
    "partitioner": {},
    "app": {},
    "assembler": {}
  },
  "config": {
    "taskTimeout": 1,
    "jobTimeout": 1,
    "isTestJob": true,
    "maxTaskRetries": 1
  },
  "userName": "alice",
  "description": "text",
  "app": "text",
  "owner": "text"
}

application/jsonapplication/x-protobuf

{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}

---

Get a template

get

Get a template by id

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

idstringRequired

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

/templates/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "text",
  "createdAt": "2025-12-18T04:03:13.263Z",
  "updatedAt": "2025-12-18T04:03:13.263Z",
  "isPublic": true,
  "partitioner": "text",
  "assembler": "text",
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "dataDestination": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "params": {
    "partitioner": {},
    "app": {},
    "assembler": {}
  },
  "config": {
    "taskTimeout": 1,
    "jobTimeout": 1,
    "isTestJob": true,
    "maxTaskRetries": 1
  },
  "userName": "alice",
  "description": "text",
  "app": "text",
  "owner": "text"
}

---

Get templates

get

List all templates created 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 templates 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

/templates

HTTPcURLJavaScriptPython

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

{
  "templates": [
    {
      "id": "text",
      "createdAt": "2025-12-18T04:03:13.263Z",
      "updatedAt": "2025-12-18T04:03:13.263Z",
      "isPublic": true,
      "partitioner": "text",
      "assembler": "text",
      "dataSource": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "dataDestination": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "params": {
        "partitioner": {},
        "app": {},
        "assembler": {}
      },
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1,
        "isTestJob": true,
        "maxTaskRetries": 1
      },
      "userName": "alice",
      "description": "text",
      "app": "text",
      "owner": "text"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  }
}