Quick Start

Get your API key and make your first API call in under 1 minute.

Step 1: Create Your Account

Sign up for an OctopusX account and log in: Sign in.

Step 2: Get Your API Key

1. Create Projects

2. Create API Keys

3. Copy and Save API Keys

Step 3: Set Up Billing

Add a card or recharge your OctopusX balance. Get $10 in API credits when you add your first card. Secure recharge payments are processed through Stripe.

Option 1: Add a Card

1. Go to Bill Information.
2. Click Add Card.
3. Enter and confirm your card details.
4. Receive $10 in API credits after adding your first card.

Option 2: Recharge Your Balance

1. Go to Bill Information.
2. Find Credit and click Recharge.
3. Select the recharge amount.
4. Complete your payment securely through Stripe.

Step 4: Send Your First API Request

Use your API key with Base URL https://octopusx.ai.

Chat with an AI Model

curl https://octopusx.ai/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o",
    "messages": [{"role": "user", "content": "Hello"}]
  }'

Generate an AI Image

curl https://octopusx.ai/v1/images/generations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-1",
    "prompt": "A calm lake at sunrise"
  }'

Generate an AI Video

curl https://octopusx.ai/v1/video/generations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "veo-3",
    "prompt": "A drone shot flying over mountains"
  }'

Upload Your Media

curl -X PUT https://octopusx.ai/v1/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@./image.png"

Retrieve Your Generation Result

curl https://octopusx.ai/v1/video/generations/{task_id} \
  -H "Authorization: Bearer YOUR_API_KEY"

Step 5: Explore 400+ AI Models

Browse 400+ AI models in the Model Library to find the right model for your application. Compare OpenAI models and alternatives for chat, reasoning, image, video, and audio generation.

Each model page includes:

• An interactive Playground for testing
• API examples, parameters, and model details
• API pricing and usage information

Next Steps

Topic	Description
API Overview	Browse supported AI models and providers
Text APIs	Chat, text generation, and reasoning
Image APIs	Text-to-image and image generation
Video APIs	Text-to-video and image-to-video
API Key	Create and manage your API keys
Error codes	Endpoints, errors, and troubleshooting
Usage	Track API usage, credits, and billing