Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.tumban.com/llms.txt

Use this file to discover all available pages before exploring further.

Fetch aggregate progress for a batch. 
GET /api/v2/batches/{batch_id}

​
Path parameters

​
batch_id
string
required
The batch_id returned by POST /api/v2/batch.

​
Response

​
batch_id
string
required
The batch id you requested.
​
status
string
required
processing while any profile is in flight; completed once every profile has reached a terminal status.
​
total_profiles
integer
required
Count of profiles in the batch.
​
completed
integer
required
Count of profiles whose scans completed successfully (including completed_with_partial).
​
failed
integer
required
Count of profiles whose scans failed.
​
in_progress
integer
required
Count of profiles still processing.
​
submitted_at
string
required
ISO 8601 UTC timestamp of when the batch was submitted.
​
completed_at
string
ISO 8601 UTC timestamp of when the last profile reached a terminal status. null while the batch is still processing.
​
profile_urls
string[]
required
The profile URLs the batch was submitted with, in submission order.

​
Example

curl https://api.tumban.com/api/v2/batches/9b8a7c6d-1234-5678-9abc-def012345678 \
  -H "Authorization: Bearer sk_xxx"

{
  "batch_id": "9b8a7c6d-1234-5678-9abc-def012345678",
  "status": "processing",
  "total_profiles": 3,
  "completed": 1,
  "failed": 0,
  "in_progress": 2,
  "submitted_at": "2026-04-29T12:00:00",
  "completed_at": null,
  "profile_urls": [
    "https://creator.example/alice",
    "https://creator.example/bob",
    "https://creator.example/carol"
  ]
}

​
Errors

StatusDetail
404Batch not found — the batch id does not exist within your organization.