Batches

Start a job uploaded with start=false

post/api/v1/batches/{batch}/start

Request

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

Path parameters

batchstring required
Example:B-7K2M9QX4TA

Job ID, as returned when the job was created (B-XXXXXXXXXX).

Request body

name_columnstring required

Header of the column holding the names, exactly as written in the file.

country_columnstring

Header of a column holding a country per row: ISO 3166-1 alpha-2, alpha-3 or the country name (FR, FRA, France, any case). Unrecognised values fall back to country.

countrystring

Default country (ISO 3166-1 alpha-2, or alpha-3) for rows without one.

ai_fallbackboolean

Ask an AI model for names not in the dataset. Requires AI consent on the account, exactly as on /gender/bulk.

best_guessboolean

Return the more likely gender even when the evidence is weak.

delete_after_downloadboolean

The result can be downloaded once, then it is deleted.

Response

Queued.

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.