Skip to content

Add postman collection for the How-to Batch Search #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
oscar-ravenpack wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add postman collection for the How-to Batch Search #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
030e259
Add postman collection for the Batch Search
oscar-ravenpack Feb 24, 2026
f5d8c91
Batch search - Add output file URL variable
oscar-ravenpack Feb 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
249 changes: 249 additions & 0 deletions how_to_guides/api_batch_search/Bigdata.com APIs.postman_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
{
"info": {
"_postman_id": "5288afa5-b1c2-4c37-b43b-357f0a77b887",
"name": "Bigdata.com APIs",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "37724809"
},
"item": [
{
"name": "Search Service",
"item": [
{
"name": "Batch Search",
"item": [
{
"name": "Create pre-signed URL to upload the batch",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Parse JSON response and save `presigned_url` to environment when present",
"pm.test(\"Response is JSON (or empty)\", function () {",
" // Allow empty responses (some endpoints may return 204)",
" const body = pm.response.text();",
" if (!body) {",
" pm.expect(true).to.be.true;",
" return;",
" }",
"",
" pm.expect(function () {",
" JSON.parse(body);",
" }).to.not.throw();",
"});",
"",
"let data;",
"try {",
" const body = pm.response.text();",
" data = body ? JSON.parse(body) : null;",
"} catch (e) {",
" data = null;",
"}",
"",
"const url = data && typeof data === 'object' ? data.presigned_url : undefined;",
"",
"if (typeof url === 'string' && url.trim().length > 0) {",
" pm.environment.set('presigned_url', url);",
"}",
"",
"const batch_id = data && typeof data === 'object' ? data.batch_id : undefined;",
"",
"if (typeof batch_id === 'string' && batch_id.trim().length > 0) {",
" pm.environment.set('batch_id', batch_id);",
"}",
"",
"",
"",
"pm.test(\"presigned_url env var is set when presigned_url is present\", function () {",
" if (typeof url === 'string' && url.trim().length > 0) {",
" pm.expect(pm.environment.get('presigned_url')).to.eql(url);",
" } else {",
" // If not present, don't fail the run; just assert it's absent/unchanged is acceptable.",
" pm.expect(true).to.be.true;",
" }",
"});",
""
],
"type": "text/javascript",
"packages": {},
"requests": {}
}
}
],
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{BIGDATA_API_URL}}/v1/search/batches",
"host": [
"{{BIGDATA_API_URL}}"
],
"path": [
"v1",
"search",
"batches"
]
}
},
"response": []
},
{
"name": "Upload search batch",
"protocolProfileBehavior": {
"disabledSystemHeaders": {
"content-type": true
}
},
"request": {
"auth": {
"type": "noauth"
},
"method": "PUT",
"header": [
{
"key": "Content-Type",
"value": "application/jsonl",
"type": "text"
}
],
"body": {
"mode": "file",
"file": {
"src": "/C:/Users/osanchez/Desktop/batch_job_file.jsonl"
}
},
"url": {
"raw": "{{presigned_url}}",
"host": [
"{{presigned_url}}"
]
}
},
"response": []
},
{
"name": "Get batch status",
"event": [
{
"listen": "test",
"script": {
"exec": [
"// Parse JSON response and save `presigned_url` to environment when present\r",
"pm.test(\"Response is JSON (or empty)\", function () {\r",
" // Allow empty responses (some endpoints may return 204)\r",
" const body = pm.response.text();\r",
" if (!body) {\r",
" pm.expect(true).to.be.true;\r",
" return;\r",
" }\r",
"\r",
" pm.expect(function () {\r",
" JSON.parse(body);\r",
" }).to.not.throw();\r",
"});\r",
"\r",
"let data;\r",
"try {\r",
" const body = pm.response.text();\r",
" data = body ? JSON.parse(body) : null;\r",
"} catch (e) {\r",
" data = null;\r",
"}\r",
"\r",
"const url = data && typeof data === 'object' ? data.output_file_url : undefined;\r",
"\r",
"if (typeof url === 'string' && url.trim().length > 0) {\r",
" pm.environment.set('output_file_url', url);\r",
"}\r",
""
],
"type": "text/javascript",
"packages": {},
"requests": {}
}
}
],
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{BIGDATA_API_URL}}/v1/search/batches/:batch_id",
"host": [
"{{BIGDATA_API_URL}}"
],
"path": [
"v1",
"search",
"batches",
":batch_id"
],
"variable": [
{
"key": "batch_id",
"value": "{{batch_id}}"
}
]
}
},
"response": []
},
{
"name": "Get response",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{output_file_url}}",
"host": [
"{{output_file_url}}"
]
}
},
"response": []
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{BIGDATA_API_KEY}}",
"type": "string"
},
{
"key": "key",
"value": "x-api-key",
"type": "string"
}
]
},
"event": [
{
"listen": "prerequest",
"script": {
"type": "text/javascript",
"packages": {},
"requests": {},
"exec": [
""
]
}
},
{
"listen": "test",
"script": {
"type": "text/javascript",
"packages": {},
"requests": {},
"exec": [
""
]
}
}
]
}
22 changes: 22 additions & 0 deletions how_to_guides/api_batch_search/Bigdata.com APIs.postman_environment.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"id": "d805d767-4af0-442a-8fdd-7f871969ecac",
"name": "Bigdata.com APIs",
"values": [
{
"key": "BIGDATA_API_KEY",
"value": "",
"type": "secret",
"enabled": true
},
{
"key": "BIGDATA_API_URL",
"value": "https://api.bigdata.com",
"type": "default",
"enabled": true
}
],
"color": null,
"_postman_variable_scope": "environment",
"_postman_exported_at": "2026-02-24T16:39:19.120Z",
"_postman_exported_using": "Postman/11.85.1-260224-0818"
}