Docs

Vortops has one address, https://api.vortops.com, and four calls. Accounts are open and keys are issued from your dashboard. Ask for early access and we will set up your account and a free test key.

Quickstart

1. Get a test key. It starts with vk_test_. Test keys never call a model and never cost anything.
2. Check it works. This returns who the key belongs to.

curl https://api.vortops.com/v1/me \
  -H "Authorization: Bearer $VORTOPS_KEY"

3. Switch to a live key (vk_live_) and ask for something real.

curl https://api.vortops.com/v1/route \
  -H "Authorization: Bearer $VORTOPS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "task": "greeting",
    "model": "@cf/meta/llama-3.2-3b-instruct",
    "input": {
      "messages": [{ "role": "user", "content": "Say hello in five words." }],
      "max_tokens": 20
    }
  }'

The reply includes what it cost.

{
  "output": { "response": "Hello there, friend, welcome!" },
  "request_id": "req_4f1c0b7a9d2e41a8b3c6d0e2",
  "model": "@cf/meta/llama-3.2-3b-instruct",
  "credits_charged": 1,
  "mode": "live"
}

Keys

• Each project has its own keys. Make a live key and a test key, and give each a name such as "Production".
• A key is shown once when it is created. Vortops keeps only a hash, so a lost key cannot be recovered. Make a new one and revoke the old one.
• Revoking a key works at once.
• Keep keys on your server. Never put one in a web page, a mobile app or a public repository. Vortops does not allow calls from browsers, on purpose.

Endpoints

Models

These are the models you can send to /v1/route today. GET /v1/models always returns the live list. Prices are in US dollars per million tokens (1 million tokens is roughly 750,000 words). Every call costs at least 1 credit. Models that think first use part of max_tokens on that thinking, so give them room.

More models are added after they are tested through Vortops. Ask for one on the early access form.

Credits

A credit is US$0.01 at list price. Each call is measured and charged at about 3.5 times what it cost to run, rounded up, with a minimum of 1 credit. A fast image costs at least 2. A call that fails is not charged. See pricing and the credits policy.

A project can be paid for by an account's credits, or by the project's own account (an internal or corporate account billed monthly). Either way you can set a monthly credit limit on a project.

Errors

Every error looks the same: a short code your code can check and a sentence a person can read.

{ "error": { "code": "insufficient_credits", "message": "There are no credits left on this account. ..." } }

VortopsBot

The website check fetches the page you ask about, the way a visitor's browser would, and a few small files such as robots.txt and sitemap.xml. It identifies itself as VortopsBot/1.0, sends no cookies, follows at most four redirects, waits at most eight seconds and reads at most 1.5 MB. It only visits public websites: addresses that point to a private network, localhost or an unusual port are refused. It runs only when a person asks for a check.

Limits

Each project has a rate limit (requests a minute) and an optional monthly credit limit. Both are set per project. Only models listed at /v1/models can be used, so nothing runs that has no price.