Chat Query

Documentation Index

Fetch the complete documentation index at: https://docs.voltai.ai/llms.txt

Use this file to discover all available pages before exploring further.

​

Request Notes

• user_id (required) — your application’s identifier for the end-user making the request. Each (API key, user_id) pair is limited to one concurrent request. If the same user already has a request in flight, the endpoint returns 429.
• mode controls the reasoning strategy. Defaults to AUTO.
  • AGENTIC — multi-step reasoning with tool use. Higher latency, best accuracy.
  • FAST — single-pass retrieval and generation. Lowest latency, good for simple look-ups.
  • AUTO — the system classifies the query and picks AGENTIC or FAST automatically.
• chat_id — send the chat_id from a previous response to continue the same thread. Omit it to start a new thread.
• topic_names (optional) — list of knowledge topic names to scope retrieval to (e.g. ["Family A", "Family B"]). Each name must match a topic in your organization (case-insensitive). If omitted or [], topic scope is chosen automatically. If any name does not match a topic, the endpoint returns 400.

​

Response Notes

• The endpoint returns a single JSON object, not an array.
• final_answer is the cleaned answer text returned by the agent.
• chat_id is the chat thread UUID (Chat primary key). Pass it back in subsequent requests to continue the conversation.
• chat_url is the web UI link for this thread: https://{app_host}/{org_name}/chat/{chat_id}, where {org_name} is the resolved organization’s name and {app_host} is your deployment’s application host.
• sources contains text citations only, with a filename, page number, and library URL.
• mode returns the reasoning mode that was actually used. When the request sends AUTO, this field reveals whether the system chose AGENTIC or FAST.

​

Concurrency & Sessions

​

Example Request

{
  "query": "What is EMEM?",
  "user_id": "usr_82af91",
  "mode": "AUTO"
}

​

Scoped to one or more topics (optional)

{
  "query": "What is the maximum operating temperature?",
  "user_id": "usr_82af91",
  "topic_names": ["Example Product Family"]
}

​

Follow-up Request (continuing a thread)

{
  "query": "What is the maximum operating temperature?",
  "user_id": "usr_82af91",
  "chat_id": "2d8a39d8-29d6-4f0f-bc5f-4c5f0f9c9d54"
}

​

Example Response

{
  "final_answer": "EMEM is embedded memory integrated into the device for storing code and data.",
  "chat_id": "2d8a39d8-29d6-4f0f-bc5f-4c5f0f9c9d54",
  "chat_url": "https://voltai.ai/ExampleOrg/chat/2d8a39d8-29d6-4f0f-bc5f-4c5f0f9c9d54",
  "sources": [
    {
      "source_name": "example-datasheet.pdf",
      "page": 12,
      "url": "https://voltai.ai/ExampleOrg/library?source_name=example-datasheet.pdf&source_page=12&source_type=text"
    }
  ],
  "mode": "FAST"
}

​

429 — Per-User Limit

{
  "error": "user_session_limit_exceeded",
  "message": "user_id 'usr_82af91' already has an active request. Please wait for it to complete.",
  "user_id": "usr_82af91"
}

​

429 — Org-Level Limit

{
  "error": "session_limit_exceeded",
  "message": "You have exceeded the session quota limit for your organization. Please try again later.",
  "total_seats": 10,
  "active_seats": 10,
  "available_seats": 0
}