Poll batches job | Instabase AI Hub Documentation

Poll the asynchronous job created when deleting a batch.

This API operation and SDK method are maintained for backward compatibility, but the functionally identical API operation poll file operation job status and its corresponding SDK method client.jobs.status() are preferred.

Poll the asynchronous job created when deleting a batch. <Info>This API operation and SDK method are maintained for backward compatibility, but the functionally identical API operation [poll file operation job status](/api-sdk/api-reference/jobs/job-status) and its corresponding SDK method [client.jobs.status()](/api-sdk/api-reference/jobs/job-status) are preferred.</Info>

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

job_idstringRequired

The job ID returned by a Delete batch request.

Headers

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See [Authorization and context identification](/api-sdk/authorization#ib-context-header) for details.

Response

Request successful

stateenum or null

The status of the job.

Allowed values:

messagestring or null

Job status message.

1	import time
2	from aihub import AIHub
3
4	client = AIHub(api_root="https://aihub.instabase.com/api",
5	api_key="abcdefghijklmnopqrst1234567890",
6	ib_context="john.doe_acme.com")
7
8	# poll the status of a job until it's done
9	while True:
10	response = client.batches.poll_job(
11	job_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890")
12	if response.state not in ["PENDING", "RUNNING"]:
13	break
14	time.sleep(3) # pause before polling the status again

1	{
2	"state": "COMPLETE",
3	"message": "string"
4	}