Skip to main content
GET
/
batches
/
{batchId}
Legacy alias: track an enrichment run (use GET /enrichment-runs/{runId})
curl --request GET \
  --url https://origami.chat/api/v2/batches/{batchId} \
  --header 'Authorization: Bearer <token>'
{
  "object": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batchId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "rowCount": 123,
  "enrichments": {
    "total": 123,
    "completed": 123,
    "pending": 123,
    "failed": 123
  },
  "creditsUsed": 123,
  "outcomes": [
    {
      "inputIndex": 123,
      "rowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "outcomeCounts": {
    "inserted": 123,
    "updated": 123,
    "skipped": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
batchId
string<uuid>
required

Response

The enrichment-run detail.

A tracked batch of column-over-row work on a table (upserts, file ingests). id is canonical; batchId is the kept legacy alias (identical value).

​
object
string
required
Allowed value: "enrichment_run"
​
id
string<uuid>
required
​
batchId
string<uuid>
required

Legacy alias of id — kept for pre-restructure consumers.

​
tableId
string<uuid>
required
​
type
string
required

The run's work type (e.g. upsert).

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

Rows this run processed. For upsert runs this is the per-row outcome ledger length (one entry per input row).

​
enrichments
object
required
​
creditsUsed
integer
required

Settled credit cost. 0 until the run reaches a terminal status.

​
outcomes
object[]

Present only on upsert-type runs — the per-row outcome ledger.

​
outcomeCounts
object

Present only on upsert-type runs.