Get batch
Check the status of an async batch. When all enrichments are complete, the response includes the full enriched row data and total credits used.
A batch is "complete" when every enrichment has reached a terminal state —
this includes both succeeded and failed runs. Check enrichments.failed > 0
to detect partial failures.
Rows in the response: When status is "complete", rows includes every
row for this batch in a single array (not paginated). Insert requests are
limited to 100 rows per batch (see POST /tables/{tableId}/rows), so
result payloads stay bounded; if that limit increases in the future, pagination
may be introduced for this field.
Polling strategy: For fast results, poll every 2–5 seconds. For background processing, poll every 30–60 seconds.
Authorizations
API key with og_live_ prefix. Create keys in Settings → API Keys.
Pass in the Authorization header:
Path Parameters
The batch ID returned by a write operation.
Response
Batch status retrieved.
The operation type that created this batch.
insert processing— enrichment is still runningcomplete— all enrichments finished (checkenrichments.failedfor partial failures)errored— the batch failed to start (e.g. enrichment pipeline error)
processing, complete, errored Number of rows created by this batch. Each row can have multiple
enrichment cells (one per enrichment column), so enrichments.total
will typically be higher than rowCount.
Breakdown of failed enrichment cells by cause. Empty object {} when there are no failures.
Total credits consumed by this batch (rounded to nearest whole credit). 0 while processing or when no credits were used.
Timestamp when the batch finished. null while still processing.
Map of column slug → display name. Only present when status is "complete".
Use this to resolve slug keys in rows to human-readable column names.
Enriched row data. Only present when status is "complete".
Row keys are column slugs — use the columns map to resolve display names.
All rows for the batch are returned in one response (see operation description
for the relationship to per-request insert limits).