StartseiteVortixy-APIAPI v1

Vortixy-API

Integriere Vortixy Chat mit einem Bearer-Schlüssel in deine Projekte. Schlüssel erstellen in Dashboard → Deine API

Gleiche Kontingente wie dein Plan Täglicher Reset um 00:00 UTC

Überblick

Vortixy ist ein ruhiger KI-Arbeitsbereich für Lernen, Schreiben, Recherchieren, Planen und tägliche Arbeit. Die öffentliche API stellt denselben Chat bereit, den du unter /chat nutzt, damit du ihn aus deiner eigenen App, deinem Skript oder Workspace aufrufen kannst. Jeder Schlüssel erbt die Limits deines aktuellen Plans — Free, Go $2, Pro $5 oder Max $9 — und alle Kontingente werden zwischen Web und API geteilt.

Basis-URL: https://www.vortixy.net/api/v1
Auth: Authorization: Bearer vtx_live_...
Content-Type: application/json
Kontingente: Tokens, Anfragen, Bilder, Websuchen — wie in deinem Plan (siehe Dashboard)

Authentifizierung

Sende deinen Schlüssel im Authorization-Header. Niemals im Client-Code oder in Query-Parametern exponieren.

curl https://www.vortixy.net/api/v1/chat \
  -H "Authorization: Bearer vtx_live_abc123..." \
  -H "Content-Type: application/json" \
  -d '{"message":"Hello Vortixy"}'

Scopes: chat, images, search, tasks, usage. Schlüssel teilen die Kontingente deines Plans.

POST /api/v1/chat

Sende eine Nachricht mit optionalem Gesprächsverlauf, aktiviere die Websuche oder passe die Denktiefe an. Wird auf das tägliche Nachrichten- und Token-Limit deines Plans angerechnet.

Chatbot-bereit: füge system für deine Bot-Persona hinzu (8k Zeichen), stream:true für NDJSON-Deltas, webSearch für Live-Quellen. Jeder Aufruf zieht Tokens, Requests und web-Suchen ab — geteilt mit Web (Reset 00:00 UTC).

Request-Felder — alle Varianten

Alle JSON-Felder für POST /api/v1/chat. Nur message ist erforderlich — alles andere optional.

Chat request fields
Feld	Typ	Erforderlich	Beschreibung
message	string	yes	Nutzer-Nachricht (1–32.000 Zeichen).
history	array	no	Vorherige Turns: [{ role: 'user' \| 'assistant', content: string }] (max. 20).
system	string	no	Bot-Persona / Anweisungen (max. 8k). Akzeptiert auch Alias instructions.
provider	string	no	gemini (verwaltet, Standard). Für BYOK speichere deinen Schlüssel unter Dashboard → Einstellungen → KI-Schlüssel und nutze dann provider openai / anthropic / deepseek / gemini mit einer BYOK-Model-ID.
model	string	no	Model-ID — siehe Tabelle unten. Muss für Provider + Plan erlaubt sein.
thinkingLevel	enum	no	none \| low \| medium \| high \| xhigh \| max (xhigh/max nur für GPT-5.6).
webSearch	boolean	no	true für Live-Websuche. Zählt zum täglichen Such-Kontingent.
stream	boolean	no	true für NDJSON-Streaming (delta → done). Standard false (JSON).

Tipp: provider/model weglassen für bestes Modell deines Plans. Setze stream:true für Chatbots.

Thinking-Stufen — alle Varianten

Reasoning is now automatic per mode — Fast uses low, Smart uses high, Auto chooses intelligently based on your question. You no longer need to pick a level. The API still accepts thinkingLevel but it is optional and overridden by the mode.

Thinking levels
Level	Beschreibung
none	Kein Nachdenken — am schnellsten, geringster Verbrauch.
low	Leichtes Nachdenken — schnelle Antworten mit etwas Überlegung.
medium	Ausgewogen — gut für die meisten Aufgaben.
high	Tiefe Überlegung — für komplexe Analyse und Planung.
xhigh	Sehr tief — nur Frontier-Modelle, für schwere Probleme.
max	Maximum — nutzt volles Thinking-Budget, am langsamsten und teuersten.

Fast → low/medium, Smart → medium/high, Auto → chooses low→high per query. No user selector needed — the system is intelligent per moment.

Chat modes — Fast / Smart / Auto

Pick a mode, not a model. Vortixy routes intelligently to make the most of your quota — no need to choose a specific model. All modes share your plan quotas (00:00 UTC).

Chat modes
Mode	When to use	Thinking	Speed
Fast	Quick answers for simple tasks — fastest, most efficient.	low / medium	Fastest
Smart	Thorough reasoning for complex tasks — deeper, step-by-step.	medium / high	Thorough
Auto	Vortixy chooses the best mode automatically per question (heuristic, zero extra cost).	auto (low → high)	Auto-chooses

Smart has an animated glow when selected (shimmer border). Auto is the default — recommended for most tasks.

BYOK models — 4 providers, free-tier (no plan gate)

Save your provider key once in Dashboard → Settings → AI keys (AES-256-GCM encrypted, never exposed) — then call with provider + model. Same 00:00 UTC quotas as managed.

BYOK models
Modell	Anbieter	Access	Thinking	Kontext
gemini-3.8-flash:byok	gemini	Free — needs key	none, low, medium, high	1049k
gemini-3.7-flash:byok	gemini	Free — needs key	none, low, medium, high	1049k
gemini-3.6-flash:byok	gemini	Free — needs key	none, low, medium, high	256k
gpt-5.6-sol	openai	Free — needs key	none, low, medium, high, xhigh, max	256k
gpt-5.6-terra	openai	Free — needs key	none, low, medium, high, xhigh, max	256k
gpt-5.6-luna	openai	Free — needs key	none, low, medium, high, xhigh, max	256k
claude-fable-5	anthropic	Free — needs key	none, high	256k
claude-opus-5	anthropic	Free — needs key	none, high	256k
claude-sonnet-5	anthropic	Free — needs key	none, high	256k
claude-haiku-4-5	anthropic	Free — needs key	none, high	200k
deepseek-v4-pro	deepseek	Free — needs key	none, high	256k
deepseek-v4-flash	deepseek	Free — needs key	none, high	256k

BYOK catalog: gpt-5.6-sol/terra/luna (openai), claude-opus-5/fable-5/sonnet-5/haiku-4-5 (anthropic), deepseek-v4-pro/flash (deepseek), gemini-3.8-flash:byok / gemini-3.7-flash:byok (gemini). All available on Free when key is present — no upgrade needed.

Kontext & automatische Kompaktierung

Modell-Kontextfenster variieren und reichen bis zu 1M (3.8/3.7) / 256k (Rest) Tokens. Jede Anfrage ist außerdem durch den Tarif begrenzt: Free 10k, Go 20k, Pro 35k oder Max 50k Tokens. Oberhalb von 85% des geltenden Budgets werden ältere Turns im Chat automatisch kompaktiert. Die öffentliche API ist zustandslos; sende die History bei jedem Aufruf erneut.

Wir schätzen Tokens mit BPE für System + History + neue Nachricht.
Wenn die Summe ≤ 85% des Tarif- und Modellbudgets ist, behalten wir die volle History.
Bei Überschreitung behalten wir die neuesten Turns, die in 80% des Budgets passen, und kompaktieren ältere zu einer Summary: „Earlier conversation (automatically compacted…)“ mit 260-Zeichen-Auszügen.
Neueste Turns + System + neue Nachricht bleiben immer erhalten; die Summary bewahrt nützliche Fakten. In /chat siehst du ein `context`-Event (used/max, compacted, compactedMessages). Auf der API entscheidest du, was du in `history` sendest — sendest du mehr als passt (z. B. 200k), antwortet der Server mit 400/429/502 statt still zu akzeptieren.

Der nutzbare Kontext ist der kleinere Wert aus Tariflimit (10k/20k/35k/50k Tokens) und Modellfenster (bis zu 1M (3.8/3.7) / 256k (Rest)). Sende bei Integrationen nur passende History und fasse ältere Turns selbst zusammen; zu große Anfragen können abgelehnt werden.

Beispiele — alle Varianten

// Basic — only required field
{ "message": "Explain quantum computing simply" }

// With system persona (chatbot) — 8k chars
{
  "message": "What do you sell?",
  "system": "You are a friendly shop assistant for Acme. Answer briefly in Spanish."
}

// With history — multi-turn conversation
{
  "message": "And what about entanglement?",
  "history": [
    { "role": "user", "content": "Hi" },
    { "role": "assistant", "content": "Hello! How can I help?" },
    { "role": "user", "content": "Explain quantum computing" }
  ]
}

// Full request — all variants together
{
  "message": "Latest AI breakthroughs with sources",
  "history": [{ "role": "user", "content": "Hi" }],
  "system": "You are Acme support. Be concise.",
  "provider": "gemini",          // managed (default) — BYOK dashboard-only for other providers
  "model": "gemini-3.5-flash",    // any available managed model from the table above
  "thinkingLevel": "high",        // none | low | medium | high | xhigh | max
  "webSearch": true,              // true = live web grounding + sources[]
  "stream": false                 // false = JSON, true = NDJSON deltas
}

// 200 OK — non-streaming response
{
  "answer": "Quantum computing uses qubits...",
  "model": "gemini-3.5-flash",
  "usage": { "tokensEstimated": 42, "tokensReserved": 42, "webSearch": true },
  "sources": [{ "title": "Quantum computing — Wikipedia", "url": "https://en.wikipedia.org/wiki/Quantum_computing" }],
  "plan": "pro"
}

// Streaming (NDJSON) — ideal for chatbots
const res = await fetch("https://www.vortixy.net/api/v1/chat", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.VORTIXY_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ message: "Hello!", system: "Be concise.", stream: true, thinkingLevel: "medium" })
});
for await (const line of res.body.pipeThrough(new TextDecoderStream()).pipeThrough(splitNDJSON())) {
  const evt = JSON.parse(line);
  if (evt.type === "delta") process.stdout.write(evt.delta);
  if (evt.type === "sources") console.log("sources", evt.sources);
  if (evt.type === "done") console.log("\nusage", evt.usage);
}

// curl variants — pick the one you need
// 1) Basic
curl -X POST https://www.vortixy.net/api/v1/chat -H "Authorization: Bearer $VORTIXY_API_KEY" -H "Content-Type: application/json" -d '{"message":"Hello"}'

// 2) With web search + high thinking
curl -X POST https://www.vortixy.net/api/v1/chat -H "Authorization: Bearer $VORTIXY_API_KEY" -H "Content-Type: application/json" -d '{"message":"Latest AI news","webSearch":true,"thinkingLevel":"high"}'

// 3) Chatbot persona + streaming (NDJSON)
curl -N -X POST https://www.vortixy.net/api/v1/chat -H "Authorization: Bearer $VORTIXY_API_KEY" -H "Content-Type: application/json" -d '{"message":"Hi","system":"You are Acme bot.","stream":true}'

Streaming sendet delta → done (NDJSON, Content-Type: application/x-ndjson). Mit webSearch:true erhältst du zusätzlich geerdete Quellen via Websuche (zählt zum täglichen Kontingent).

429 quota exceeded → Retry-After401 invalid key → WWW-Authenticate

GET /api/v1/models

Listet Modelle, die dein aktueller Plan nutzen kann (plangesteuert, ohne Quota-Kosten). Zum Befüllen eines Modell-Pickers im Chatbot.

curl https://www.vortixy.net/api/v1/models -H "Authorization: Bearer vtx_live_..."

// 200 OK — example for Pro plan (more models on Max, fewer on Free)
{
  "plan": "pro",
  "defaultModel": "gemini-3.5-flash",
  "models": [
    { "id": "gemini-3.5-flash", "label": "Gemini 3.5 Flash", "provider": "gemini", "thinkingLevels": ["none","low","medium","high"] },
    { "id": "gemini-3.5-flash-lite", "label": "Gemini 3.5 Flash Lite", "provider": "gemini", "thinkingLevels": ["none","low","medium","high"] },
    { "id": "gemini-3.1-flash-lite", "label": "Gemini 3.1 Flash Lite", "provider": "gemini", "thinkingLevels": ["none","low","medium","high"] }
  ]
}

Note: gemini-3.8-flash/gemini-3.7-flash/gemini-3.6-flash temporarily paused (effective 3.5+lite) — example shows effective models only.

Free enthält nur den Fast-Modus; Go, Pro und Max enthalten Fast, Smart und Auto — Kontingente skalieren mit dem Plan (12k/50k/120k/250k Tokens pro Tag, 5/20/50/100 Anfragen). BYOK-Modelle benötigen Ihren Key und sind hier nicht gelistet.

BYOK — eigene Provider-Schlüssel per API nutzenBYOK via API

Bring deinen eigenen Schlüssel für OpenAI, Anthropic, DeepSeek oder Gemini mit. Einmal in der App konfigurieren und überall nutzen — Web und API teilen dieselben gespeicherten Schlüssel und dieselben täglichen Kontingente (Reset 00:00 UTC).

1. Gehe in Vortixy zu Dashboard → Einstellungen → KI-Schlüssel und speichere deinen Schlüssel (OpenAI sk-..., Anthropic sk-ant-..., DeepSeek sk-..., oder Gemini AQ./AIza...). Er wird verschlüsselt (AES-256-GCM) und nie offengelegt.
2. Rufe POST /api/v1/chat mit provider und model aus dem BYOK-Katalog auf (z. B. provider: "openai", model: "gpt-5.6-terra" oder provider: "anthropic", model: "claude-opus-5").
3. Nutze weiterhin denselben Bearer-Schlüssel von Vortixy — der Provider-Schlüssel wird serverseitig aufgelöst. Kontingente, Streaming, thinkingLevel und webSearch funktionieren gleich für verwaltete und BYOK-Modelle.

BYOK-Beispiel

# 1) Save your provider key once in Vortixy (Dashboard → Settings → AI keys)
#    OpenAI sk-..., Anthropic sk-ant-..., DeepSeek sk-..., Gemini AQ./AIza...

# 2) Call the API with the same Vortixy Bearer key, but specify the BYOK provider+model
curl https://www.vortixy.net/api/v1/chat \
  -H "Authorization: Bearer vtx_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Explain quantum computing with deep reasoning",
    "provider": "openai",
    "model": "gpt-5.6-terra",
    "thinkingLevel": "high",
    "stream": false
  }'

# Anthropic example
curl https://www.vortixy.net/api/v1/chat \
  -H "Authorization: Bearer vtx_live_..." \
  -H "Content-Type: application/json" \
  -d '{"message":"Write a haiku about the sea","provider":"anthropic","model":"claude-opus-5"}'

# DeepSeek example
curl https://www.vortixy.net/api/v1/chat \
  -H "Authorization: Bearer vtx_live_..." \
  -H "Content-Type: application/json" \
  -d '{"message":"Solve this algorithm","provider":"deepseek","model":"deepseek-v4-pro","thinkingLevel":"high"}'

// JS — BYOK via Vortixy API (same quotas, same Bearer key)
const res = await fetch("https://www.vortixy.net/api/v1/chat", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.VORTIXY_API_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    message: "Deep research with my own OpenAI key",
    provider: "openai",
    model: "gpt-5.6-sol",
    thinkingLevel: "xhigh", // xhigh/max only on GPT-5.6 — works via BYOK
    webSearch: true,
    stream: false
  })
});
const data = await res.json();
// data.answer, data.sources, data.usage, data.model

Fehlt der Schlüssel, erhältst du 403 byokMissing — füge ihn im Dashboard hinzu und versuche erneut. BYOK-Anfragen zählen ebenfalls zu Tokens / Anfragen / Suchen deines Plans.

BYOK catalog: gpt-5.6-sol / terra / luna (openai), claude-opus-5 / fable-5 / sonnet-5 / haiku-4-5 (anthropic), deepseek-v4-pro / flash (deepseek), gemini-3.8-flash:byok / gemini-3.7-flash:byok / gemini-3.6-flash:byok (gemini). Managed Gemini models stay available without BYOK.

POST /api/v1/images

Erstelle Bilder im Standard- oder Qualitätsmodus. Wird auf das tägliche Bildlimit deines Plans angerechnet.

curl https://www.vortixy.net/api/v1/images \
  -H "Authorization: Bearer vtx_live_..." \
  -H "Content-Type: application/json" \
  -d '{"prompt":"a cozy minimalist living room, warm light","quality":"quality"}'

{ "image": { "mimeType": "image/png", "base64": "..." }, "remaining": 49 }

quality: "standard" (schnell, günstig) oder "quality" (hohe Detailtreue). Zählt zum Tages-Bild-Kontingent (Free 2/Tag, Go 8, Pro 30, Max 60).

GET /api/v1/usage

Prüfe deinen aktuellen Plan und verbleibende Kontingente ohne Tokens zu verbrauchen.

curl https://www.vortixy.net/api/v1/usage -H "Authorization: Bearer vtx_live_..."

{ "plan":"pro","limits":{"aiTokensPerDay":120000,"aiRequestsPerDay":50},"resetsInSeconds": 43200 }

Web Search & Research

Setze webSearch: true, damit Vortixy bei Bedarf aktuelle Infos aus dem Web abruft. Im Recherche-Modus werden komplexe Fragen in parallele Teilanfragen aufgeteilt und Quellen zurückgegeben.

await fetch("https://www.vortixy.net/api/v1/chat", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.VORTIXY_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ message: "Latest AI breakthroughs with sources", webSearch: true })
});

webSearch: false (Standard, ohne Web) | true (erweiterte Websuche, 5 Ergebnisse, zitierte Quellen). Jeder true-Aufruf zählt 1 für dein tägliches Suchkontingent (Free 10/Tag, Go 25/Tag, Pro 50/Tag, Max 100/Tag).

Tasks & Projects

Bleib organisiert mit Projekten und geplanten Aufgaben. Verwalte sie über das Dashboard oder den Chat — die API respektiert dieselben Planlimits für Bereiche, Dateien und Aufgaben.

Beispiel: Schreib im Chat „Erinnere mich jeden Montag um 9 Uhr daran, meine Woche zusammenzufassen“ — Vortixy erstellt eine geplante Aufgabe, die du im Dashboard siehst.

Chats — memoria guardada

Guarda conversaciones en Vortixy para no reenviar el historial cada vez. Mismo límite que tu plan (Free 30, Go 100, Pro 300, Max 400).

GET  /api/v1/chats          # lista tus chats
POST /api/v1/chats          # {title} -> crea uno
GET  /api/v1/chats/:id      # detalle
PATCH /api/v1/chats/:id     # {title} renombra
DELETE /api/v1/chats/:id
GET  /api/v1/chats/:id/messages?limit=50
POST /api/v1/chats/:id/messages  # {role, content}

// POST /api/v1/chats
{ "title": "Mi proyecto Tesis" }
// -> { "chat": { "id": "uuid", "title": "Mi proyecto Tesis" } }

// POST /api/v1/chats/uuid/messages
{ "role": "user", "content": "Hola" }

Files — subir documentos

Sube PDFs, Word, texto o imágenes (20 MiB) para usarlos luego en el chat. Cuenta como artefacto diario (Free 3/día, Go 10/día, Pro 25/día, Max 60/día).

curl https://www.vortixy.net/api/v1/files \
  -H "Authorization: Bearer vtx_live_..." -F file=@tarea.pdf

# JSON alternativo
curl -X POST https://www.vortixy.net/api/v1/files \
  -H "Authorization: Bearer vtx_live_..." -H "Content-Type: application/json" \
  -d '{"name":"tarea.pdf","mimeType":"application/pdf","base64":"..."}'

GET /api/v1/files?limit=20 -> { "files": [{ "id": "...", "name": "tarea.pdf" }] }

Projects — carpetas de estudio

Crea espacios con instrucciones fijas. Límites Free 1 / Go 3 / Pro 8 / Max 15.

GET  /api/v1/projects
POST /api/v1/projects  # {title, subject, instructions}
GET  /api/v1/projects/:id
PATCH /api/v1/projects/:id
DELETE /api/v1/projects/:id

Study Generate — Modo Examen

Genera flashcards o quiz desde un texto (Free 2/día, Go 5/día, Pro 12/día, Max 20/día). Luego puedes exportar a Anki.

curl https://www.vortixy.net/api/v1/study/generate \
  -H "Authorization: Bearer vtx_live_..." -H "Content-Type: application/json" \
  -d '{"content":"texto largo de apuntes...","kind":"flashcards","count":10}'

{ "kind": "flashcards", "items": [{ "front": "¿Qué es...?", "back": "Es..." }] }

POST /api/v1/chat/completions — compatible con OpenAI

Mismo chat pero con formato OpenAI: {messages:[{role,content}]}. Ideal para usar cualquier SDK de OpenAI cambiando solo la URL base a https://www.vortixy.net/api/v1.

// OpenAI SDK
import OpenAI from "openai";
const client = new OpenAI({
  baseURL: "https://www.vortixy.net/api/v1",
  apiKey: process.env.VORTIXY_API_KEY
});
const res = await client.chat.completions.create({
  model: "gemini-3.5-flash",
  messages: [{role:"user", content:"Hola"}]
});
console.log(res.choices[0].message.content);

curl https://www.vortixy.net/api/v1/chat/completions \
  -H "Authorization: Bearer vtx_live_..." -H "Content-Type: application/json" \
  -d '{"messages":[{"role":"user","content":"Hola"}],"stream":false}'

API compatible con OpenAI (2026)

Vortixy expone un espejo 100% compatible con el formato de OpenAI Chat Completions (2026). Cambia solo baseURL y tu apiKey — el mismo código funciona con el SDK oficial de OpenAI, Vercel AI SDK, LangChain o cualquier cliente compatible. Streaming usa SSE estándar data: {...} + data: [DONE] (como OpenAI 2026). Las mismas cuotas del plan (tokens/requests/búsquedas) se comparten con /api/v1/chat.

// OpenAI JS SDK — sin cambiar lógica
import OpenAI from "openai";
const vortixy = new OpenAI({
  baseURL: "https://www.vortixy.net/api/v1",
  apiKey: process.env.VORTIXY_API_KEY, // vtx_live_...
});
const res = await vortixy.chat.completions.create({
  model: "gemini-3.5-flash",
  messages: [
    { role: "system", content: "Eres un tutor amable." },
    { role: "user", content: "Explícame fotosíntesis en 3 bullets" }
  ],
  stream: false,
  // web_search / webSearch también soportado (alias):
  // web_search: true
});
console.log(res.choices[0].message.content);
// res.usage => { prompt_tokens, completion_tokens, total_tokens }
// res.sources => [{title, url}] si webSearch:true

// Streaming SSE (igual que OpenAI 2026)
const stream = await vortixy.chat.completions.create({
  model: "gemini-3.5-flash",
  messages: [{ role: "user", content: "Hola" }],
  stream: true,
});
for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content || "");
}

// Vercel AI SDK (2026)
import { createOpenAI } from "@ai-sdk/openai";
const vortixy = createOpenAI({
  baseURL: "https://www.vortixy.net/api/v1",
  apiKey: process.env.VORTIXY_API_KEY,
});
const { text } = await generateText({
  model: vortixy("gemini-3.5-flash"),
  prompt: "Resume este PDF en 5 puntos",
});

curl https://www.vortixy.net/api/v1/chat/completions \
  -H "Authorization: Bearer vtx_live_..." -H "Content-Type: application/json" \
  -d '{
    "model": "gemini-3.5-flash",
    "messages": [{"role":"user","content":"Hola"}],
    "stream": false
  }'

# con búsqueda web (alias 2026 tolerante):
# "web_search": true  o  "webSearch": true  -> grounding Tavily + sources[]

# Python
# from openai import OpenAI
# client = OpenAI(base_url="https://www.vortixy.net/api/v1", api_key="vtx_live_...")
# res = client.chat.completions.create(model="gemini-3.5-flash", messages=[{"role":"user","content":"Hola"}])

Nota 2026: formato idéntico a OpenAI — id: chatcmpl-..., object: chat.completion, choices[0].message, usage y streaming data: {choices: [{delta: {content: "..."}}]} + data: [DONE]. Envelope SSE estándar (OpenAI-compatible). 401 sin Bearer, 429 con Retry-After/RateLimit-*.

Webhooks

Recibe avisos en tu servidor cuando algo pasa. Máx 5 por cuenta.

GET  /api/v1/webhooks          # lista
POST /api/v1/webhooks          # {url, events:["chat.completed","task.completed","quota.warning"]}
DELETE /api/v1/webhooks?id=uuid

OpenAPI

Spec completo en GET /api/v1/openapi para importar en Postman, Insomnia o generar SDK.

curl https://www.vortixy.net/api/v1/openapi

Fehler

Alle Fehler folgen RFC 9457 mit lokalisierter Meldung. Prüfe das Feld code für die programmatische Behandlung.

{ "error": "You reached the daily quota. Try again after 2h.", "code": "quotaExceeded", "retryAfter": 7200 }

API errors
Status	Code	When
400	validation	Ungültiges JSON oder Feld außerhalb des Bereichs
401	apiKeyInvalid	Fehlender oder ungültiger Bearer-Schlüssel
403	planRequired	Modell für deinen Plan nicht erlaubt
403	byokMissing	BYOK-Schlüssel für diesen Anbieter fehlt — speichere ihn in Dashboard → Einstellungen → KI-Schlüssel
429	quotaExceeded	Tageskontingent Tokens / Requests / Suchen erreicht
502	aiEngineFailed	Upstream-Modellfehler

Header: RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, Retry-After, WWW-Authenticate on 401.

Schnellstart (Node.js)

Kopieren, einfügen und ausführen. Node 18+ hat fetch bereits — kein extra Paket nötig.

// Node 18+ — no install needed
const res = await fetch("https://www.vortixy.net/api/v1/chat", {
  method: "POST",
  headers: {
    Authorization: "Bearer " + process.env.VORTIXY_API_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    message: "Turn these notes into a plan: ...",
    system: "You are a concise assistant.",
    thinkingLevel: "medium",
    webSearch: false,
    stream: false
  })
});
const data = await res.json();
console.log(data.answer);

// Streaming chatbot
const streamRes = await fetch("https://www.vortixy.net/api/v1/chat", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.VORTIXY_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ message: "Hello!", stream: true })
});
for await (const chunk of streamRes.body) {
  // parse NDJSON lines: {type:"delta", delta:"..."} -> {type:"done", answer:"..."}
}

// Image
const imgRes = await fetch("https://www.vortixy.net/api/v1/images", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.VORTIXY_API_KEY, "Content-Type": "application/json" },
  body: JSON.stringify({ prompt: "minimalist logo for Vortixy", quality: "quality" })
});
const { image } = await imgRes.json();
// image.base64 -> save as PNG

// Python — same API
// import requests
// r = requests.post("https://www.vortixy.net/api/v1/chat",
//   headers={"Authorization": f"Bearer {API_KEY}", "Content-Type": "application/json"},
//   json={"message": "Hello!", "thinkingLevel": "high", "webSearch": True})
// print(r.json()["answer"])

In Chat testen →API-Schlüssel holen