Converse with a document | Instabase AI Hub Documentation

Converse with a document in a conversation.

This endpoint supports querying a single document at a time and supports the standard and advanced models. To converse with multiple documents, or to use the multistep model or research mode, use the Run query endpoint.

Converse with a document in a conversation. <Tip>This endpoint supports querying a single document at a time and supports the standard and advanced models. To converse with multiple documents, or to use the multistep model or research mode, use the [Run query](/api-sdk/api-reference/queries/run-query) endpoint.</Tip>

Authentication

AuthorizationBearer

Bearer HTTP authentication.

Path parameters

conversation_idstringRequired

The conversation ID.

You can list conversations and get their IDs with the List conversations endpoint.

The conversation ID. <Tip>You can list conversations and get their IDs with the [List conversations](/api-sdk/api-reference/conversations/list-conversations/) endpoint.</Tip>

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.

Request

This endpoint expects an object.

questionstringRequired

The question to ask the document.

document_idslist of integersRequired

The IDs of the documents to query.

modeenumOptional

The model to use to answer the question. Supports the standard (default) and advanced (advanced) models. See Choosing a model for details about each model.

The multistep model and research mode are not supported. To use the multistep model or research mode in a query, use the Run query endpoint.

The model to use to answer the question. Supports the standard (`default`) and advanced (`advanced`) models. See [Choosing a model](/overview/models/) for details about each model. <Note>The multistep model and research mode are not supported. To use the multistep model or research mode in a query, use the [Run query](/api-sdk/api-reference/queries/run-query) endpoint.</Note>

Allowed values:

fast_modebooleanOptionalDefaults to false

This should match the value of the fast_mode parameter used when creating the conversation. Mismatched values may cause the API response to take longer than normal.

Response

Successful response, the answer is returned.

prompt_idstring or null

The ID of the prompt.

answerstring or null

The answer to the question asked.

1	# AI Hub Python SDK example
2	from aihub import AIHub
3
4	client = AIHub(api_root="<API-ROOT>",
5	api_key="<API-TOKEN>",
6	ib_context="<IB-CONTEXT>")
7	answer = client.conversations.converse(conversation_id='<CONVERSATION-ID>',
8	question="What is the main topic of the document?",
9	document_ids=[<DOCUMENT-ID>],
10	mode="default")