aVenture APIHelp

Deprecated: answer a natural-language platform help question

Deprecated
View as Markdown

Deprecated: use help ask (POST /v1/help) with the same body.

Authentication

AuthorizationBearer

User bearer token: Clerk session JWT, Clerk OAuth access token, or Clerk API key

Request

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

Optional chat model that answers the question; null uses the configured default. A caller without admin authority may only choose an allowlisted model; an ineligible model is rejected with 422. Admin callers are unrestricted.

scopeenum or nullOptional

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

Allowed values:

Response headers

X-RateLimit-Limitinteger

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

X-RateLimit-Remaininginteger

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

X-RateLimit-Resetinteger

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:

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