v1

latestOpenAPI 3.0.12026-07-24251036.5 KB

Studies

Check candidate upload status

Check the status of a candidate upload.

Use the status_url returned by the upload request. It is a relative path, so use the same API host and bearer token.

processing: Wait before submitting another batch to this study.
finished: You can submit the next batch.
failed: Review message before retrying.

An upload ID works only for the account and study that created it.

get/v1/studies/{study_id}/candidate_uploads/{id}

Path parameters

study_idinteger required

The study ID

idstring required

The opaque upload ID from status_url

Response

candidate upload status

Example response

{
  "data": {
    "id": "abc123",
    "attributes": {
      "submitted_count": 5000,
      "status_url": "/v1/studies/11111/candidate_uploads/abc123"
    }
  }
}