Ask a question
POST/beta/questions
Asks a natural language question and returns the result.
This endpoint is the primary way to interact with Veezoo programmatically using natural language. It supports follow-up questions through conversation IDs, allowing multi-turn conversations.
New conversations: Omit conversationId from the request body. The response will include a
new conversationId that you can use for follow-up questions.
Follow-up questions: Include the conversationId from a previous response. The question will
automatically reference the last answer in that conversation, enabling contextual follow-ups like
"Break down by region" or "Only for last year."
Request
Responses
- 200
- 400
- 401
- 402
- 404
- 429
- 500
The question was processed successfully.
The response includes an ordered stream of text and answer messages plus a conversation ID for follow-up questions.
Individual answer messages may be partial. In that case, some fields such as data or sql
may be omitted, and errorMessage explains what failed while still preserving any information
that could be generated.
Note that isError may be true even with a 200 status code, indicating that the question was
understood but could not be answered (e.g. the requested data is not available).
The API request is invalid.
Possible reasons are:
- The request is missing a required query parameter
- The request body does not match the required schema
The API request failed to authenticate.
Possible reasons are:
- The request doesn't specify an API key
- The specified API key does not exist or has been revoked
- The user tied to the API key does no longer exist or is no longer authorized
API access is not enabled for your subscription.
The specified Knowledge Graph does not exist.
The API request exceeds the rate limit.
Processing the question failed due to an internal error.