batch

Run the same edits over many records

One template document, one set of edits with {placeholders}, many records (inline or from records_url): one output document per record, as a job. Answers 202 with a job_id; GET /v1/jobs/{job_id} returns one entry per record once it is done, or set options.webhook_url.

post/v1/batch

Request

  • Base URL: https://api.niubai.vip (the document declares no server; this is the origin it was published from)
  • URL: https://api.niubai.vip/v1/batch
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes a retry safe. The same key with the same body returns the first request's result (a replay, never a second charge); a duplicate that arrives while the first is still running waits for it, then answers 409 conflict if it has not finished; the same key with a different body is refused 400. Without the header the gateway derives a key from the request's content, so a blind retry of a timed-out POST is still safe. Keys are scoped to the account and the key's mode.

Request body

recordsobject[] nullable
records_urlstring uri nullable

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.