BEbenchling
Protein

Get bulk-create-and-register-proteins-and-components task status

Get the current status of a bulk-create-and-register-proteins-and-components task. When a job reaches a COMPLETED status, you can call the GET /tasks/bulk-create-and-register-proteins-and-components/{task_id}/results endpoint to fetch task results and errors.

Task IDs for this endpoint remain queryable for 14 days after the job is created. After that TTL expires, this endpoint returns 404. Retrieve any status and results you need before the task ID expires.

get/api/v3/tasks/bulk-create-and-register-proteins-and-components/{task_id}

Request

  • Base URL
    https://{tenant_name}.benchling.com
  • Auth
    HTTP bearer

Path parameters

task_idstring required

Headers

EARLY-ACCESSstring

Set to true to access beta operations via /api/v3.

Response

Job status details

messagestring nullable

A human-readable message describing why the task failed. Present only when status is FAILED.

status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

The current status of the task.

  • NOT_STARTED: Task has been created but not yet started.
  • IN_PROGRESS: Task is currently running.
  • COMPLETED: Task finished. Check 'result.hasErrors' to determine if there were validation errors.
  • FAILED: Task encountered an internal error (system failure). This is distinct from user-facing validation errors, which result in a COMPLETED status with hasErrors=true.
taskIdstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.