Ask a document questions, get probabilities back
VAKYN reads a piece of text or JSON once and answers your questions about it: yes or no, which of several options, or where on a scale. Every answer is a probability distribution, not a guess dressed up as a fact.
VAKYN speaks a Jev-compatible HTTP API (the API of TypeSafe's Jev), so the official TypeSafe SDKs for Python and JavaScript work against it once you point their base URL at VAKYN. It runs in two places, with the same requests and the same answers:
| VAKYN MAX | Self-hosted | |
|---|---|---|
| Base URL | https://api.vakyn.com | your open-server, e.g. http://localhost:8080 |
| API key | from the console | vakyn keys create or open-server's dashboard |
| Cost | $0.0294 per million input tokens; output is free | free; your hardware |
| Your data | sent to our servers for the call | never leaves your machine |
Get started
Questions
Reference
- API referenceEndpoints, schemas, limits, prices, errors and headers.
- Python SDKThe official typesafe-sdk package, pointed at VAKYN.
- JavaScript SDKThe official @typesafe-ai/sdk package, pointed at VAKYN.
- SwitchingFrom a hosted Jev-compatible API: change the base URL and the key.
- Self-hostingopen-server: install, commands, flags, the model, backups and Docker.
In one minute
A request has a state (the thing you want judged: an email, a ticket, a form as JSON) and a set of named questions. There are three kinds:
noul
Yes or no. You get the probability of yes.
choice
One of up to 255 named options. You get the pick, a probability per option and a confidence.
score
A level on an ordered scale of up to 10. You get the expected level, the distribution and a confidence.
All questions in a request are answered from one reading of the state, so asking ten questions about a document costs little more than asking one. Everything goes through a single endpoint, POST /v1/systemone.
Where to start
New here? The quickstart takes you from nothing to a first answer in a few minutes, hosted or on your machine. Already calling a Jev-compatible API? Set TYPESAFE_BASE_URL to https://api.vakyn.com or your server and use a key from it; your code does not change otherwise. See Switching.