API reference
Generated from the OpenAPI schema. Interactive version: API explorer; raw schema: openapi.json.
Base URL: https://api.vana.annamal.ai. All /v1/* endpoints require Authorization: Bearer <key>. Model: vana-3.0 (Vana 3.0; aliases vana-3, vana-latest).
Endpoints
GET /health
Health
200Successful Response — map → any
GET /v1/models
List Models
200Successful Response — ModelsList422Validation Error — HTTPValidationError
GET /v1/balance
Balance
200Successful Response — map → any422Validation Error — HTTPValidationError
POST /v1/systemone
Systemone
Request body: DecisionRequest
200Successful Response — DecisionResponse422Validation Error — HTTPValidationError
POST /v1/decide
Decide Alias
Request body: DecisionRequest
200Successful Response — DecisionResponse422Validation Error — HTTPValidationError
Response headers on /v1/systemone and /v1/decide: x-vana-input-tokens, x-vana-output-tokens, x-ratelimit-limit, x-ratelimit-remaining (keys with a per-minute limit). Errors: see errors.md.
Schemas
ChoiceAnswer
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
type |
"choice" |
"choice" |
||
choice |
string | yes | ||
probabilities |
map → number | yes | ||
confidence |
number | yes |
DecisionRequest
POST /v1/systemone body.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
model |
string | null | Model id: vana-3.0 (aliases vana-3, vana-latest). Default vana-3.0. | ||
state |
string | map → any | array of any | yes | ||
questions |
map → QuestionSpec | yes |
DecisionResponse
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
model |
string | yes | ||
answers |
map → ChoiceAnswer | NoulAnswer | ScoreAnswer | yes | ||
usage |
Usage |
HTTPValidationError
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
detail |
array of ValidationError |
ModelInfo
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
id |
string | yes | ||
object |
string | "model" |
||
owned_by |
string | "annamal.ai" |
||
display_name |
string | null | |||
aliases |
array of string | |||
context_length |
integer | null | |||
languages |
array of string |
ModelsList
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
object |
string | "list" |
||
data |
array of ModelInfo | yes |
NoulAnswer
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
type |
"noul" |
"noul" |
||
noul |
number | yes | ||
probabilities |
map → number | null | |||
confidence |
number | null |
QuestionSpec
One typed decision question.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
type |
QuestionType | yes | ||
instructions |
string | "" |
||
criteria |
any |
QuestionType
Values: choice, noul, score
ScoreAnswer
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
type |
"score" |
"score" |
||
score |
number | yes | ||
legend |
map → string | yes | ||
probabilities |
map → number | yes | ||
confidence |
number | yes |
Usage
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
input_tokens |
integer | 0 |
||
output_tokens |
integer | 0 |
ValidationError
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
loc |
array of string | integer | yes | ||
msg |
string | yes | ||
type |
string | yes | ||
input |
any | |||
ctx |
object |