Get query status | Instabase AI Hub Documentation

1 import time 2 from aihub import AIHub 3 4 client = AIHub( 5 api_root="https://aihub.instabase.com/api", 6 api_key="abcdefghijklmnopqrst1234567890", 7 ib_context="john.doe_acme.com" 8 ) 9 10 # are the query's responses ready yet? 11 while True: 12 response = client.queries.status( 13 query_id="a1b2c3d4-e5f6-7890-abcd-ef1234567890" 14 ) 15 16 if response.status == "COMPLETE": 17 break 18 time.sleep(3) # pause, then poll again 19 20 # print the responses 21 for query_result in response.results: 22 print(query_result.response)

1 { 2 "query_id": "01917eb8-4c73-7981-b664-c0559e09a499", 3 "status": "COMPLETE", 4 "results": [ 5 { 6 "response": "The email was sent out on Monday, March 11, 2024, at 08:16:16 +0000.", 7 "source_documents": [ 8 { 9 "name": "test.eml", 10 "pages": [ 11 { 12 "page_number": 1, 13 "bboxes": [] 14 } 15 ] 16 } 17 ] 18 } 19 ] 20 }

Conversations and chatbots are deprecated and will be removed on February 1, 2026. You can continue to create and use conversations and chatbots until then.

Get the status of an asynchronous query. If the status is COMPLETE, this request also returns the query response.

<Info>Conversations and chatbots are deprecated and will be removed on February 1, 2026. You can continue to create and use conversations and chatbots until then.</Info> Get the status of an asynchronous query. If the status is `COMPLETE`, this request also returns the query response.

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

query_idstringRequired

The unique identifier of the query. This value is returned by a Run query 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

Query result successfully retrieved.

query_idstring

The unique identifier of the query.

statusenum

Status of the query.

Allowed values:

resultslist of objects or null

The query response. Returned only if the query status is COMPLETE.

errorstring or null

Present only if the status is FAILED. Contains a message with information about the source of the execution error, such as "message":"Invalid query uuid passed".