SDK first answer

SDK 1.1.0 is a prepared release. Registry publication is pending; use a qualified archive from your Q administrator until publication is confirmed.

For a request without SDK installation, use Build with Q.

Set Q_API_KEY and Q_API_BASE_URL in your backend environment. The standard API root is https://api.qdivision.ai/v1; use the root supplied with your environment. The key needs ai:answer. Keep service credentials on your backend.

Use Python 3.11+ or Node 22+.

PythonCopy Anchor Link

After publication is confirmed, install this exact version in your application:

python -m pip install 'getq==1.1.0'

Save as first_answer.py and run python3 first_answer.py.

import asyncio
import os

from q_client import Q


async def main():
    async with Q(
        api_key=os.environ["Q_API_KEY"],
        base_url=os.environ["Q_API_BASE_URL"],
    ) as q:
        result = await q.answer.run(query="What is retrieval augmented generation?")
        print(result.model_dump_json(include={"answer", "sources", "citations", "quality"}))


asyncio.run(main())

JavaScript / TypeScriptCopy Anchor Link

After publication is confirmed, install this exact version in your application:

npm install --save-exact @getq/sdk@1.1.0

Save as first-answer.mjs and run node first-answer.mjs. The same client API works in TypeScript.

import { Q } from "@getq/sdk";

const { Q_API_KEY, Q_API_BASE_URL } = process.env;
if (!Q_API_KEY || !Q_API_BASE_URL) throw new Error("Set Q_API_KEY and Q_API_BASE_URL on your backend.");
const q = new Q({ apiKey: Q_API_KEY, baseUrl: Q_API_BASE_URL });
const { answer, sources, citations, quality } = await q.answer.run({
  query: "What is retrieval augmented generation?",
});
console.log(JSON.stringify({ answer, sources, citations, quality }, null, 2));

The result includes answer, sources, citations and quality. Check evidence and quality before showing an answer as grounded. Real requests may incur usage charges.

For streams use answer.events or answer.collect, which distinguish provisional text from the final result. See SDK support for supported operations, transport deadlines and migration; troubleshooting covers errors.