aVenture APIAgent Help

Answer a natural-language platform help question

View as Markdown

Retrieves the most relevant operations, skills, and completion gates, then returns a grounded, citation-bearing answer. Unsupported questions abstain (LOW confidence) rather than invent a command.

Authentication

AuthorizationBearer

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

OR
X-API-Keystring

Admin API key for system-to-system write operations

OR
X-Client-Secretstring

Client secret for read-only service-to-service access (no writes)

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 CLIENT_SECRET (non-admin) caller may only choose a client-secret-eligible model (owned by app.inference.client-secret-eligible-chat-model); an ineligible model is rejected with 422. Admin keys are unrestricted.

scopeenum or nullOptional

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

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.
recommendedCommandstring or nullOptional

Canonical CLI/MCP/API command the asker should run, when one is supported by the cited corpus; null when no single command applies or the model abstains.

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