Introduction

Vortyx Pulse gives you a single model, vortyx-1, for text-based chat and reasoning. Every request goes to the same base URL and endpoint.

Base URL

https://vortyx-pulse-backend.onrender.com/v1

All requests and responses are JSON over HTTPS.

Audio and video are not available yet. The API and dashboard currently support text only — those modalities will be added once the model supports them.

Authentication

Every request must include your API key in the Authorization header. Keys are created and revoked from your dashboard.

1  Authorization: Bearer vp_live_••••••••••••••••

Keep keys server-side. Never expose a live key in client-side code. Use a backend relay if you need to call Vortyx Pulse from a browser or mobile app.

Quickstart

1. Create a key

Sign up, then generate your first API key from the API Keys tab in your dashboard. Free accounts can create up to 5 keys.

2. Send a request

curl https://vortyx-pulse-backend.onrender.com/v1/chat \
  -H "Authorization: Bearer vp_live_••••••••" \
  -H "Content-Type: application/json" \
  -d '{"input": "Say hello"}'

3. Read the response

{
  "id": "resp_8f2ac1",
  "model": "vortyx-1",
  "output": "Hello! How can I help?",
  "usage": { "input_tokens": 4, "output_tokens": 6 }
}

Chat / text

POST/v1/chat

Send a text prompt and get a reasoning response back.

Param	Type	Description
input	string	Prompt text required
web_search	boolean	When true, live Google search results are fetched and given to the model as context before it answers. Off by default.

Streaming

Not available yet — every response is currently returned in full once generation finishes, rather than streamed incrementally.

API keys

Keys are created from the dashboard and shown once at creation, then masked. Use the eye icon next to a key to reveal it again at any time, or the revoke button to permanently disable it.

Free plan: up to 5 active keys
Any paid plan: unlimited keys
Revoked keys stop working immediately and cannot be restored

Rate limits & tiers

Plan	Keys	Requests / min	Monthly tokens
Free	5 max	8	50,000
3-Month / Annual	Unlimited	60	2,000,000
Permanent	Unlimited	120	Unlimited

Token usage resets automatically 30 days after your last reset — visible on your dashboard's Usage tab. A request that would exceed your rate limit or monthly quota is rejected before it reaches the model.

Errors

Code	Meaning
401	Missing or invalid API key
403	Key revoked or plan expired
422	Missing required parameter
429	Rate limit exceeded, or monthly token quota exceeded
502	The model itself failed to respond — retry with backoff

Go to dashboard →