curl --request GET \
--url https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAZ",
"status": "processing",
"total": 43,
"pending": 12,
"processing": 3,
"completed": 27,
"failed": 1,
"rows": [
{
"row_number": 2,
"event_id": "ride_001",
"status": "completed",
"task_run_id": "01BXC4MDEKTSV4RRFFQ69G5FBW",
"error_message": null,
"steps": {
"create_task_run": {
"status": "completed",
"error_message": null
},
"start_run": {
"status": "completed",
"error_message": null
},
"complete_task_run": {
"status": "completed",
"error_message": null
},
"end_run": {
"status": "completed",
"error_message": null
},
"validate_run": {
"status": "completed",
"error_message": null
}
}
},
{
"row_number": 3,
"event_id": "ride_002",
"status": "failed",
"task_run_id": null,
"error_message": "Resource not found with id: 01ARZ3NDEKTSV4RRFFQ69G5FAV",
"steps": {
"create_task_run": {
"status": "failed",
"error_message": "Resource not found with id: 01ARZ3NDEKTSV4RRFFQ69G5FAV"
},
"start_run": {
"status": "pending",
"error_message": null
},
"complete_task_run": {
"status": "pending",
"error_message": null
},
"end_run": {
"status": "pending",
"error_message": null
},
"validate_run": {
"status": "pending",
"error_message": null
}
}
}
]
}{
"error": "Invalid or missing token"
}{
"error": "Forbidden"
}{
"error": "Batch upload not found"
}Get task batch upload status
Poll the status of a task batch upload. Returns overall progress and per-row status. The batch status is processing while any rows are still pending or in progress, and completed once all rows have finished (whether successfully or not).
Authentication accepts either a subnet API key or a subnet-admin JWT from the BitRobot dashboard.
curl --request GET \
--url https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-stage.bitrobot.ai/subnets/{subnet_id}/task_batch_uploads/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "01ARZ3NDEKTSV4RRFFQ69G5FAZ",
"status": "processing",
"total": 43,
"pending": 12,
"processing": 3,
"completed": 27,
"failed": 1,
"rows": [
{
"row_number": 2,
"event_id": "ride_001",
"status": "completed",
"task_run_id": "01BXC4MDEKTSV4RRFFQ69G5FBW",
"error_message": null,
"steps": {
"create_task_run": {
"status": "completed",
"error_message": null
},
"start_run": {
"status": "completed",
"error_message": null
},
"complete_task_run": {
"status": "completed",
"error_message": null
},
"end_run": {
"status": "completed",
"error_message": null
},
"validate_run": {
"status": "completed",
"error_message": null
}
}
},
{
"row_number": 3,
"event_id": "ride_002",
"status": "failed",
"task_run_id": null,
"error_message": "Resource not found with id: 01ARZ3NDEKTSV4RRFFQ69G5FAV",
"steps": {
"create_task_run": {
"status": "failed",
"error_message": "Resource not found with id: 01ARZ3NDEKTSV4RRFFQ69G5FAV"
},
"start_run": {
"status": "pending",
"error_message": null
},
"complete_task_run": {
"status": "pending",
"error_message": null
},
"end_run": {
"status": "pending",
"error_message": null
},
"validate_run": {
"status": "pending",
"error_message": null
}
}
}
]
}{
"error": "Invalid or missing token"
}{
"error": "Forbidden"
}{
"error": "Batch upload not found"
}Authorizations
API key authentication. Your API key should start with brb_.
Example: Authorization: Bearer brb_1234567890abcdef
Path Parameters
The unique identifier of the subnet (ULID format)
^[0-9A-HJKMNP-TV-Z]{26}$The batch upload ID returned from the upload endpoint
^[0-9A-HJKMNP-TV-Z]{26}$Response
Batch status retrieved successfully
Batch upload ID
^[0-9A-HJKMNP-TV-Z]{26}$"01ARZ3NDEKTSV4RRFFQ69G5FAZ"
processing while any rows are pending or in progress; completed once all rows have finished
processing, completed "processing"
Total number of rows in the batch
43
Number of rows not yet started
12
Number of rows currently being processed
3
Number of rows successfully processed
27
Number of rows that failed
1
Show child attributes
Show child attributes