Jobs

PreviousJobs API NextData Source

Last updated 17 days ago

Was this helpful?

Create a new job

Create a new computing job on ByteNite.

post

/jobs

Authorizations

Body

jobIdstring

Unique identifier for the job, automatically generated if left blank.

namestring

Mnemonic name for the job.

templateIdstringrequired

Identifier of the application template used for this job.

descriptionstring

Textual description of the job.

dataSourceobject

The data source object specifying configurations for inputs and outputs. Please refer to the dedicated guide for detailed instructions.

dataDestinationobject

The data source object specifying configurations for inputs and outputs. Please refer to the dedicated guide for detailed instructions.

paramsobject

configobject

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/customer/jobs' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"name":"My job","templateId":"[email protected]"}'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-02-22T04:27:58.462Z",
    "submittedAt": "2025-02-22T04:27:58.462Z",
    "startedAt": "2025-02-22T04:27:58.462Z",
    "completedAt": "2025-02-22T04:27:58.462Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "schema": "text",
      "data": {},
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {},
      "selectedOutputs": [
        1
      ]
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": "text",
    "deletedAt": "2025-02-22T04:27:58.462Z",
    "createdAt": "2025-02-22T04:27:58.462Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": "text",
    "errorMessage": "text",
    "description": "text",
    "taskTimeout": 1,
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-02-22T04:27:58.462Z"
    }
  }
}

A successful response.

Get jobs

Get all jobs for user with optional filters

get

/jobs

Authorizations

Query parameters

pagination.limitinteger · int64

Results per page

pagination.offsetinteger · int64

The number of items to skip before starting to collect the result set

orderBystring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.bytenite.com/v1/customer/jobs' \
  --header 'Authorization: YOUR_API_KEY'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  },
  "data": [
    {
      "id": "text",
      "templateId": "text",
      "name": "text",
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1
      },
      "priority": "EXECUTION_PRIORITY_UNDEFINED",
      "startAt": "2025-02-22T04:27:58.462Z",
      "submittedAt": "2025-02-22T04:27:58.462Z",
      "startedAt": "2025-02-22T04:27:58.462Z",
      "completedAt": "2025-02-22T04:27:58.462Z",
      "regions": {
        "blacklist": [
          "text"
        ],
        "whitelist": [
          "text"
        ]
      },
      "state": "JOB_STATE_NEW",
      "dataSource": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "params": {
        "schema": "text",
        "data": {},
        "preset": "text",
        "partitioner": {},
        "assembler": {},
        "app": {},
        "selectedOutputs": [
          1
        ]
      },
      "dataDestination": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "duration": "text",
      "deletedAt": "2025-02-22T04:27:58.462Z",
      "createdAt": "2025-02-22T04:27:58.462Z",
      "paymentAmount": 1,
      "numUnitsEstimation": "text",
      "numChunks": "text",
      "errorMessage": "text",
      "description": "text",
      "taskTimeout": 1,
      "stateTimestamps": {
        "ANY_ADDITIONAL_PROPERTY": "2025-02-22T04:27:58.462Z"
      }
    }
  ]
}

A successful response.

Get jobs filtered

Get all jobs for user and filter them

post

/jobs/filter

Authorizations

Body

paginationobject

orderBystring

filtersobject[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.bytenite.com/v1/customer/jobs/filter' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"pagination":{},"filters":[{"condition":"FILTER_CONDITION_EQ","value":{"ANY_ADDITIONAL_PROPERTY":"anything"}}]}'

200

400

401

403

404

500

503

default

application/json

application/x-protobuf

{
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  },
  "data": [
    {
      "id": "text",
      "templateId": "text",
      "name": "text",
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1
      },
      "priority": "EXECUTION_PRIORITY_UNDEFINED",
      "startAt": "2025-02-22T04:27:58.462Z",
      "submittedAt": "2025-02-22T04:27:58.462Z",
      "startedAt": "2025-02-22T04:27:58.462Z",
      "completedAt": "2025-02-22T04:27:58.462Z",
      "regions": {
        "blacklist": [
          "text"
        ],
        "whitelist": [
          "text"
        ]
      },
      "state": "JOB_STATE_NEW",
      "dataSource": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "params": {
        "schema": "text",
        "data": {},
        "preset": "text",
        "partitioner": {},
        "assembler": {},
        "app": {},
        "selectedOutputs": [
          1
        ]
      },
      "dataDestination": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "duration": "text",
      "deletedAt": "2025-02-22T04:27:58.462Z",
      "createdAt": "2025-02-22T04:27:58.462Z",
      "paymentAmount": 1,
      "numUnitsEstimation": "text",
      "numChunks": "text",
      "errorMessage": "text",
      "description": "text",
      "taskTimeout": 1,
      "stateTimestamps": {
        "ANY_ADDITIONAL_PROPERTY": "2025-02-22T04:27:58.462Z"
      }
    }
  ]
}

A successful response.