Read


Get job

get

Get job properties

Authorizations
Path parameters
jobIdstringRequired

The id associated with your job.

Responses
200
A successful response.
get
GET /v1/customer/jobs/{jobId} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-07-12T08:42:25.162Z",
    "submittedAt": "2025-07-12T08:42:25.162Z",
    "startedAt": "2025-07-12T08:42:25.162Z",
    "endedAt": "2025-07-12T08:42:25.162Z",
    "regions": {
      "blacklist": [
        "text"
      ],
      "whitelist": [
        "text"
      ]
    },
    "state": "JOB_STATE_NEW",
    "dataSource": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "params": {
      "preset": "text",
      "partitioner": {},
      "assembler": {},
      "app": {}
    },
    "dataDestination": {
      "dataSourceDescriptor": "s3",
      "params": {
        "@type": "text",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "duration": 1,
    "deletedAt": "2025-07-12T08:42:25.162Z",
    "createdAt": "2025-07-12T08:42:25.162Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-07-12T08:42:25.162Z"
    },
    "appId": "text",
    "templateInfo": {
      "id": "text",
      "owner": "text",
      "description": "text",
      "app": "text",
      "partitioner": "text",
      "assembler": "text"
    }
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}


Get results

get

Get job results

Authorizations
Path parameters
jobIdstringRequired

The id associated with your job.

Responses
200
A successful response.
get
GET /v1/customer/jobs/{jobId}/results HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "results": [
    {
      "name": "text",
      "link": "text"
    }
  ]
}


Get jobs

get

Get all jobs for user with optional filters

Authorizations
Query parameters
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.

orderBystringOptional
Responses
200
A successful response.
get
GET /v1/customer/jobs HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  },
  "data": [
    {
      "id": "text",
      "templateId": "text",
      "name": "text",
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1,
        "isTestJob": true
      },
      "priority": "EXECUTION_PRIORITY_UNDEFINED",
      "startAt": "2025-07-12T08:42:25.162Z",
      "submittedAt": "2025-07-12T08:42:25.162Z",
      "startedAt": "2025-07-12T08:42:25.162Z",
      "endedAt": "2025-07-12T08:42:25.162Z",
      "regions": {
        "blacklist": [
          "text"
        ],
        "whitelist": [
          "text"
        ]
      },
      "state": "JOB_STATE_NEW",
      "dataSource": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "params": {
        "preset": "text",
        "partitioner": {},
        "assembler": {},
        "app": {}
      },
      "dataDestination": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "duration": 1,
      "deletedAt": "2025-07-12T08:42:25.162Z",
      "createdAt": "2025-07-12T08:42:25.162Z",
      "paymentAmount": 1,
      "numUnitsEstimation": "text",
      "numChunks": 1,
      "errorMessage": "text",
      "description": "text",
      "stateTimestamps": {
        "ANY_ADDITIONAL_PROPERTY": "2025-07-12T08:42:25.162Z"
      },
      "appId": "text",
      "templateInfo": {
        "id": "text",
        "owner": "text",
        "description": "text",
        "app": "text",
        "partitioner": "text",
        "assembler": "text"
      }
    }
  ]
}


Get jobs filtered

post

Get all jobs for user and filter them

Authorizations
Body
orderBystringOptional
Responses
200
A successful response.
post
POST /v1/customer/jobs/filter HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 216

{
  "pagination": {
    "limit": 1,
    "offset": 1
  },
  "filters": [
    {
      "field": "text",
      "condition": "FILTER_CONDITION_EQ",
      "value": {
        "@type": "type.googleapis.com/google.protobuf.Value",
        "value": "value to filter (any type)"
      }
    }
  ],
  "orderBy": "text"
}
{
  "pagination": {
    "total": 1,
    "offset": 1,
    "hasPrevious": true,
    "hasNext": true
  },
  "data": [
    {
      "id": "text",
      "templateId": "text",
      "name": "text",
      "config": {
        "taskTimeout": 1,
        "jobTimeout": 1,
        "isTestJob": true
      },
      "priority": "EXECUTION_PRIORITY_UNDEFINED",
      "startAt": "2025-07-12T08:42:25.162Z",
      "submittedAt": "2025-07-12T08:42:25.162Z",
      "startedAt": "2025-07-12T08:42:25.162Z",
      "endedAt": "2025-07-12T08:42:25.162Z",
      "regions": {
        "blacklist": [
          "text"
        ],
        "whitelist": [
          "text"
        ]
      },
      "state": "JOB_STATE_NEW",
      "dataSource": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "params": {
        "preset": "text",
        "partitioner": {},
        "assembler": {},
        "app": {}
      },
      "dataDestination": {
        "dataSourceDescriptor": "s3",
        "params": {
          "@type": "text",
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "duration": 1,
      "deletedAt": "2025-07-12T08:42:25.162Z",
      "createdAt": "2025-07-12T08:42:25.162Z",
      "paymentAmount": 1,
      "numUnitsEstimation": "text",
      "numChunks": 1,
      "errorMessage": "text",
      "description": "text",
      "stateTimestamps": {
        "ANY_ADDITIONAL_PROPERTY": "2025-07-12T08:42:25.162Z"
      },
      "appId": "text",
      "templateInfo": {
        "id": "text",
        "owner": "text",
        "description": "text",
        "app": "text",
        "partitioner": "text",
        "assembler": "text"
      }
    }
  ]
}

Last updated

Was this helpful?