Skip to navigation
aVenture APIAgents and SystemAgents

Answer a Natural-Language Platform Help Question

View as Markdown

Answers a question about how to use aVenture, citing the operations it draws on. A question it cannot answer returns LOW confidence instead of a guessed command. With resolve, it returns a recommended operation or workflow, or a clarifying question, instead of a written answer, under its own per-account limit. Free for every signed-in account.

Authentication

AuthorizationBearer

Your aVenture API key (https://aventure.vc/settings/api-keys) or OAuth access token

Request

This endpoint expects an object.
questionstringRequired>=1 character
The question to answer, in natural language.
modelstring or nullOptional

Optional supported model id for the answer. Leave the field out for the server’s model; a value that is not a supported model id answers 422.

resolvebooleanOptional

True recommends the operation or workflow that does what the question asks, or asks a clarifying question, instead of writing an answer. It ignores model and has its own per-account limit.

scopeenum or nullOptional

Optional scope restricting which operations the answer may recommend; null means all.

Allowed values:

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
answerstring

Answer drawn only from the cited corpus; abstains when unsupported.

citationlist of objects

Corpus evidence backing the answer; empty when the model abstains.

confidenceenum
Confidence the answer is fully supported by the cited corpus. LOW signals an abstention.
Allowed values:
resolutionobject or nullOptional

The task or operation resolution when the question asked to resolve; absent for a generated answer.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error