Skip to navigation
Benchling APITenant Metering Summary

Poll async task status

Beta

Poll the status of the “Export the tenant’s usage of credits as a CSV file” task.

Export the tenant’s usage of Benchling credits as a CSV file. Returns a task; when the task completes, its result contains a presigned download url and an expiration timestamp.

Notes

  • Requires tenant admin permission.
  • The report reflects only AI credits.
  • Returns 400 if fromTimestamp is later than toTimestamp, or if userId does not identify a user in the tenant.
  • If the export cannot retrieve all usage in the requested range, the result has truncated: true, no url, and a message explaining why. Narrow the time range and try again.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired
ID of the asynchronous task to poll.

Headers

EARLY-ACCESSstringOptional

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

Response

OK
messagestring
statusenum
Allowed values:
resultobject or nullOptional

The result of exporting a tenant’s AI-credit usage as a CSV file.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error