Quickstart

VAKYN runs in two places with the same API. VAKYN MAX is hosted by us at https://api.vakyn.com and charged per input token. open-server runs the open models on your own machine, free. Every code sample in these docs has a switch for the two; pick one and it stays picked.

1. Get an API key

VAKYN MAX

1. Sign in to the console with Google, GitHub or X. You get an organization of your own.
2. Add balance under Billing: $10, $50 or $200, or a coupon code. Your first top-up is matched, up to $100. Calls cost $0.0294 per million input tokens; output is free.
3. Create a key under API keys. It is shown once; store it now.

Self-hosted

Install open-server, start it with a VAKYN model and create a key on it:

# Linux and macOS (Apple Silicon); Windows: see Self-hostingcurl -fsSL https://github.com/vakyn-ai/open-server/releases/latest/download/install.sh | sh vakyn serve --model vakyn/VAKYN-4B-UQFF# Admin account created. Username: admin  Password: <printed once># vakyn listening on http://127.0.0.1:8080# (the first start downloads the release from Hugging Face, with a progress bar) # in a second terminalvakyn keys create --name my-app# Created key 'my-app'. It is shown only once; store it now:# vk_…

The server listens right away and answers 503 until the model is loaded. Installer options, the service, every flag and Docker are in Self-hosting; the source is on GitHub.

2. Point your client at VAKYN

The official TypeSafe SDKs read their base URL and key from the environment. Set both once and every example in these docs, curl included, runs unchanged:

export TYPESAFE_BASE_URL=https://api.vakyn.comexport TYPESAFE_API_KEY=vk_…   # from vakyn.com/console/keys

pip install typesafe-sdk        # Python 3.10 or newer

3. Ask a first question

One state, one yes/no question. The answer is the probability that the answer is yes.

curl -s "https://api.vakyn.com/v1/systemone" \  -H "Authorization: Bearer $TYPESAFE_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "model": "jev-latest",    "state": "My order #4471 arrived with a cracked screen. I would like a replacement, not a refund.",    "questions": {      "damaged": {        "type": "noul",        "instructions": "Does the customer report a damaged item?"      }    }  }'

{  "model": "vakyn-fake",  "answers": {    "damaged": {      "type": "noul",      "noul": 0.97,      "stats": {}    }  },  "usage": {    "input_tokens": 27,    "output_tokens": 0  },  "assets_used": null}

answers is keyed by the names you gave your questions. usage.input_tokens counts what the model read, and is what VAKYN MAX charges for; nothing is generated, so output_tokens is always 0.

Next

1. Concepts: what a state is and how questions are written.
2. Noul, Choice and Score: the three question types in detail.
3. API reference: limits, errors, prices and headers.
4. Switching: moving code from a hosted Jev-compatible API.