Batches

Status of a file job

Poll this until status is completed, failed or cancelled. poll_after_seconds suggests how long to wait between calls.

get/api/v1/batches/{batch}

Request

  • Base URL: https://namegender.com
  • URL: https://namegender.com/api/v1/batches/{batch}
  • 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).

Response

The job.

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.