Batches

Upload a file and start processing it

Uploads a CSV or XLSX file (up to 100 MB, 1,000,000 rows) and, by default, queues it. One credit per row, reserved when processing begins; a job that fails is not charged.

name_column is required unless start=false: a guessed column that turns out to be wrong would spend credits on the wrong data. Send start=false to get the columns, a preview and the credit cost first, then call /start.

If starting fails (no credits, unknown column, AI consent), nothing is left behind: no job, no stored file.

Send an Idempotency-Key header to retry safely: a repeat with the same key returns the first job with 200 and Idempotent-Replayed: true instead of opening a second one.

post/api/v1/batches

Request

  • Base URL: https://namegender.com
  • URL: https://namegender.com/api/v1/batches
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Headers

Idempotency-Keystring

Up to 80 printable ASCII characters, unique per upload. SDKs generate one for you.

Response

Replay of an earlier request with the same Idempotency-Key.

idstring
status'uploaded' | 'queued' | 'processing' | 'completed' | 'failed' | 'cancelled'
source'api' | 'panel'
progressinteger
data_versionstring nullable
poll_after_secondsinteger nullable
created_atstring date-time nullable
started_atstring date-time nullable
finished_atstring date-time nullable
expires_atstring date-time nullable

Example response

{
  "id": "B-7K2M9QX4TA"
}

Changes

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