Skip to main content
GET
/
v1
/
search
/
batches
/
{batch_id}
Get Batch Job Info
curl --request GET \
  --url https://api.bigdata.com/v1/search/batches/{batch_id} \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.bigdata.com/v1/search/batches/{batch_id}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/v1/search/batches/{batch_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.bigdata.com/v1/search/batches/{batch_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 => [
"X-API-KEY: <api-key>"
],
]);

$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.bigdata.com/v1/search/batches/{batch_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-KEY", "<api-key>")

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.bigdata.com/v1/search/batches/{batch_id}")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.bigdata.com/v1/search/batches/{batch_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "batch_id": "<string>",
  "output_file_url": "<string>"
}
{
"statusCode": 123,
"message": "<string>"
}
{
"statusCode": 123,
"message": "<string>"
}
{
"statusCode": 123,
"message": "<string>"
}
{
"statusCode": 123,
"message": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

batch_id
string
required

Response

OK

batch_id
string
required

The unique identifier for your batch job.

status
enum<string>
required

Current processing state of your batch job. Poll this endpoint until status reaches completed or failed.

Available options:
pending,
processing,
completed,
failed,
cancelled
output_file_url
string<uri> | null

Presigned URL to download your results. Available only when status is completed. Use a simple GET request to download the .jsonl results file.