Skip to main content

Getting Started

Use these steps to make a first request against Voxvey API.

1. Set the base URL​

export VOXVEY_API_BASE="https://api.voxvey.com"

2. Set your access token​

export VOXVEY_TOKEN="<access-token>"

3. Check service health​

/health is public.

curl "$VOXVEY_API_BASE/health"

Expected response:

{"status":"ok"}

4. List models​

curl "$VOXVEY_API_BASE/v1/models" \
  -H "Authorization: Bearer $VOXVEY_TOKEN"

5. Send a chat completion​

curl "$VOXVEY_API_BASE/v1/chat/completions" \
  -H "Authorization: Bearer $VOXVEY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-4o-mini",
    "messages": [
      {"role": "user", "content": "Write a one sentence launch note."}
    ],
    "stream": false
  }'

The model ID must include a provider prefix such as openai/, gemini/, anthropic/, xai/, perplexity/, deepseek/, or byte/.