Read
Get job properties
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-26T17:51:34.707Z",
"submittedAt": "2025-08-26T17:51:34.707Z",
"startedAt": "2025-08-26T17:51:34.707Z",
"endedAt": "2025-08-26T17:51:34.707Z",
"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-08-26T17:51:34.707Z",
"createdAt": "2025-08-26T17:51:34.707Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-26T17:51:34.707Z"
},
"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 job results
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
GET /v1/customer/jobs/{jobId}/results HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*
{
"results": [
{
"name": "text",
"link": "text"
}
]
}
Get all jobs for user with optional filters
Number of rows to return per page.
Number of rows to skip before starting to collect the result set.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-26T17:51:34.707Z",
"submittedAt": "2025-08-26T17:51:34.707Z",
"startedAt": "2025-08-26T17:51:34.707Z",
"endedAt": "2025-08-26T17:51:34.707Z",
"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-08-26T17:51:34.707Z",
"createdAt": "2025-08-26T17:51:34.707Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-26T17:51:34.707Z"
},
"appId": "text",
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
]
}
Get all jobs for user and filter them
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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-08-26T17:51:34.707Z",
"submittedAt": "2025-08-26T17:51:34.707Z",
"startedAt": "2025-08-26T17:51:34.707Z",
"endedAt": "2025-08-26T17:51:34.707Z",
"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-08-26T17:51:34.707Z",
"createdAt": "2025-08-26T17:51:34.707Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-08-26T17:51:34.707Z"
},
"appId": "text",
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
]
}
Last updated
Was this helpful?