Documentation

API Documentation

Everything you need to integrate ORVEXA's API into your application.

Quickstart

Get an API Key

Create an account and generate your API key from the dashboard.

Go to Dashboard

Set Your Base URL

Use the following base URL for all API requests:

https://api.orvexaproject.com/v1

Make Your First Request

Send a simple chat completion request using cURL:

curl https://api.orvexaproject.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ORVEXA_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

Authentication

All API requests require authentication. Include your API key in the Authorization header using the Bearer scheme:

Authorization: Bearer your-api-key-here

Never share your API key. Keep it secure and rotate it regularly.

Endpoints

POST/v1/chat/completions

Send a chat completion request to the model. Supports both streaming and non-streaming responses.

StreamingSSE

GET/v1/models

List all available models. Supports pagination with cursor-based navigation.

Pagination

Code Examples

cURL

curl https://api.orvexaproject.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ORVEXA_API_KEY" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

Python

from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="https://api.orvexaproject.com/v1"
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "user", "content": "Hello!"}
    ]
)

print(response.choices[0].message.content)

Node.js

import OpenAI from 'openai';

const client = new OpenAI({
    apiKey: 'your-api-key',
    baseURL: 'https://api.orvexaproject.com/v1'
});

const response = await client.chat.completions.create({
    model: 'gpt-4o',
    messages: [
        { role: 'user', content: 'Hello!' }
    ]
});

console.log(response.choices[0].message.content);

Streaming (Python)

from openai import OpenAI

client = OpenAI(
    api_key="your-api-key",
    base_url="https://api.orvexaproject.com/v1"
)

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[
        {"role": "user", "content": "Tell me a story"}
    ],
    stream=True
)

for chunk in stream:
    if chunk.choices[0].delta.content is not None:
        print(chunk.choices[0].delta.content, end="")

Models

Retrieve a list of available models. The response includes pagination information.

# Get all available models
curl https://api.orvexaproject.com/v1/models \
  -H "Authorization: Bearer $ORVEXA_API_KEY"

# Response includes pagination
{
  "data": [
    {"id": "gpt-4o", "object": "model", "owned_by": "openai"},
    {"id": "gpt-4o-mini", "object": "model", "owned_by": "openai"},
    {"id": "deepseek-v3", "object": "model", "owned_by": "deepseek"}
  ],
  "object": "list",
  "has_more": true,
  "next_page": "cursor_token"
}

# Pagination with cursor
curl "https://api.orvexaproject.com/v1/models?after=cursor_token&limit=20" \
  -H "Authorization: Bearer $ORVEXA_API_KEY"

Error Codes

Code	Message	Solution
401	Unauthorized - invalid or missing API key.	Check that your API key is correct and included in the Authorization header.
402	Payment Required - insufficient balance or quota exceeded.	Add credits to your account or upgrade your plan.
429	Too Many Requests - rate limit exceeded.	Wait a moment and retry, or increase your rate limit.
500	Internal Server Error - unexpected server issue.	Try again later or contact support if the issue persists.
502	Bad Gateway - upstream service error.	Check the status page or retry after a short delay.

Free Tier

No credit card required. Start calling the API instantly, and register when you're ready for higher limits.

Start instantly, no sign-up required
Free access to popular models
No credit card required
Quota resets every 24 hours

Create free account

MCP Integration

Connect ORVEXA to your AI agents and IDEs through the Model Context Protocol.

View MCP Docs

Compatible Clients

Use ORVEXA with popular OpenAI-compatible SDKs and tools.

View Clients