POST
/
ask
curl --location 'https://document-query.pyqai.com/ask' \
--header 'Authorization: ExmpleAPIToken' \
--header 'Content-Type: application/json' \
--data '{"account_id" : ExampleAccountId, "input_sequence" : "Example query", "index_name" : "ExampleIndex"}'

{
    "response": {
        "question": "Your input sequence query!",
        "answer": "Pyq's AI has answered your query.\n",
        "sources": "source_1, source_2, source_3",
        "source_documents": [
            {
                "page_content": "Some information from your documents.",
                "metadata": {
                    "source": "source_1"
                }
            },
            {
                "page_content": "Some information from your documents.",
                "metadata": {
                    "source": "source_2"
                }
            },
            {
                "page_content": "Some information from your documents.",
                "metadata": {
                    "source": "source_3"
                }
            }
        ]
    }
}

​
Body Parameters

account_id
int
required

This is your account ID.

input_sequence
string
required

This is the query you wish to answer using documents from the given index.

index_name
string

This is the name of the index you wish to query with. This parameter is optional - if left blank will use auto indexing.

model
string

This is an optional parameter specifying if you would like to use Anthropic’s Claude instead of our default. The value “claude” will result in using that for your query.

​
Headers

Authorization
string
required

This is your API token associated with your account.

​
Response

question
string

Your input_sequence query.

answer
string

Pyq AI’s response to your query.

sources
list

List of sources consulted to get answer.

source_documents
list

Most relevant sections from the sources consulted to get the answer.

List DocumentsAsk Pyq AI with Formatted Output