Skip to main content
GET
/
batches
/
{batchId}
Get batch
curl --request GET \
  --url https://origami.chat/api/v1/batches/{batchId} \
  --header 'Authorization: Bearer <token>'
{
  "batchId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "tableId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "type": "insert",
  "status": "processing",
  "rowCount": 2,
  "enrichments": {
    "total": 10,
    "completed": 4,
    "pending": 6,
    "failed": 0
  },
  "failures": {},
  "creditsUsed": 0,
  "createdAt": "2026-07-01T14:30:00Z",
  "completedAt": null
}

Authorizations

​
Authorization
string
header
required

API key with og_live_ prefix. Create keys in Settings → API Keys.

Pass in the Authorization header:

Authorization: Bearer og_live_abc123...

Path Parameters

​
batchId
string<uuid>
required

The batch ID returned by a write operation.

Response

Batch status retrieved.

​
batchId
string<uuid>
required
​
tableId
string<uuid>
required
​
type
enum<string>
required

The operation type that created this batch.

Available options:
insert
​
status
enum<string>
required
  • processing — enrichment is still running
  • complete — all enrichments finished (check enrichments.failed for partial failures)
  • errored — the batch failed to start (e.g. enrichment pipeline error)
Available options:
processing,
complete,
errored
​
rowCount
integer
required

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.

​
enrichments
object
required
​
failures
object
required

Breakdown of failed enrichment cells by cause. Empty object {} when there are no failures.

​
creditsUsed
integer
required

Total credits consumed by this batch (rounded to nearest whole credit). 0 while processing or when no credits were used.

​
createdAt
string<date-time>
required
​
completedAt
string<date-time> | null
required

Timestamp when the batch finished. null while still processing.

​
columns
object

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.

​
rows
object[]

Enriched row data. Only present when status is "complete". Row keys are column slugs — use the columns map to resolve display names.