Create a Batch Job

curl --request POST \
  --url https://api.bigdata.com/v1/search/batches \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/v1/search/batches', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

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

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

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

response = http.request(request)
puts response.read_body

{
  "batch_id": "2211478e-45a8-4d2e-ac51-77e25f6f7c79",
  "presigned_url": "https://batch-search.bigdata.com/input/2211478e-45a8-4d2e-ac51-77e25f6f7c79/input.jsonl?Expires=...&Signature=...&Key-Pair-Id=..."
}

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

Batch Search

Create a Batch Job

Process large volumes of requests asynchronously.

Batch Search provides a simple set of endpoints to initiate batch processing jobs, monitor progress as requests are executed, and collect results once processing completes.

Each batch begins with a .jsonl file where every line represents an individual Search request.

Once your input file is ready, call the following endpoint to obtain a batch_id and presigned_url.

Copy the presigned_url from the response. You will need this URL to upload your input file.

For a step-by-step walkthrough, see the Batch Search how-to guide.

POST

batches

Create a Batch Job

curl --request POST \
  --url https://api.bigdata.com/v1/search/batches \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'POST', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.bigdata.com/v1/search/batches', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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"

	req, _ := http.NewRequest("POST", 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))

}

require 'uri'
require 'net/http'

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

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

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

response = http.request(request)
puts response.read_body

{
  "batch_id": "2211478e-45a8-4d2e-ac51-77e25f6f7c79",
  "presigned_url": "https://batch-search.bigdata.com/input/2211478e-45a8-4d2e-ac51-77e25f6f7c79/input.jsonl?Expires=...&Signature=...&Key-Pair-Id=..."
}

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

{
  "statusCode": 123,
  "message": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Response

batch_id

string

required

A unique identifier for your batch job. Use this ID to check the status of your batch.

presigned_url

string<uri>

required

A signed URL on batch-search.bigdata.com for uploading your input file, valid for one hour. Upload your .jsonl file to this URL using a PUT request. Use the URL exactly as returned, because the query parameters carry the signature. Once uploaded, your batch job will begin processing automatically.

Required string length: 1 - 2083

API

Knowledge Graph

Search Service

Watchlists

Monitors

Research Service

Content

Structured Data

Subscription

SDK

Create a Batch Job

Authorizations

Response