API Manual

​

Platform Features

​

OpenAI Compatible Mode

• 🤖 OpenAI: gpt-4o, gpt-5-chat-latest, gpt-3.5-turbo, etc.
• 🧠 Anthropic: claude-sonnet-4-20250514, claude-opus-4-1-20250805, etc.
• 💎 Google: gemini-2.5-pro, gemini-2.5-flash, etc.
• 🚀 xAI: grok-4-0709, grok-3, etc.
• 🔍 DeepSeek: deepSeek-r1, deepSeek-v3, etc.
• 🌟 Alibaba: Qwen series models
• 💬 Moonshot: Kimi models, etc.

​

Feature Support Scope

• 💬 Chat Completions: Chat Completions interface
• 🖼️ Image Generation: gpt-image-1, flux-kontext-pro, flux-kontext-max, etc.
• 🔊 Audio Processing: Whisper transcription
• 📊 Embeddings: Text vectorization
• ⚡ Function Calling: Function Calling
• 📡 Streaming Output: Real-time response
• 🔧 OpenAI Parameters: temperature, top_p, max_tokens, etc.
• 🆕 Responses Endpoint: OpenAI latest features

• 🔧 Fine-tuning interface
• 📁 Files management interface
• 🏢 Organization management interface
• 💳 Billing management interface

​

Easy Model Switching

# Using GPT-4o
response = client.chat.completions.create(
    model="gpt-4o",  # OpenAI model
    messages=[...]
)

# Switch to Claude, everything else stays the same!
response = client.chat.completions.create(
    model="claude-3.5-sonnet",  # Only change model name
    messages=[...]
)

# Switch to Gemini
response = client.chat.completions.create(
    model="gemini-1.5-pro",  # Only change model name
    messages=[...]
)

​

Quick Start

​

Get API Key

1. Visit APIYI Console
2. Login to your account
3. Click “New” in the token management page to create an API Key
4. Copy the generated API Key for API calls

​

View Request Examples

1. Go to Token Management Page
2. Find the row with your API Key
3. Click the 🔧wrench icon (tool icon) in the “Actions” column
4. Select “Request Examples” in the popup menu
5. View complete code examples including the following languages:

• cURL - Command line testing
• Python (SDK) - Using official OpenAI library
• Python (requests) - Using requests library
• Node.js - JavaScript/TypeScript
• Java - Java application development
• C# - .NET application development
• Go - Go language development
• PHP - Web development
• Ruby - Ruby application development
• And more languages…

• ✅ Complete & Runnable: Copy and paste to use
• ✅ Parameter Descriptions: Detailed parameter configuration
• ✅ Error Handling: Includes exception handling logic
• ✅ Best Practices: Follows development standards of each language

​

Basic Information

​

API Endpoints

• Primary Endpoint: https://api.apiyi.com/v1
• Backup Endpoint: https://vip.apiyi.com/v1

​

Authentication

Authorization: Bearer YOUR_API_KEY

​

Request Format

• Content-Type: application/json
• Encoding: UTF-8
• Request Method: POST (most interfaces)

​

Core Interfaces

​

1. Chat Completions

POST /v1/chat/completions

{
  "role": "system|user|assistant",
  "content": "Message content"
}

curl -X POST "https://api.apiyi.com/v1/chat/completions" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [
      {"role": "system", "content": "You are a helpful AI assistant."},
      {"role": "user", "content": "Hello! Please introduce yourself."}
    ],
    "temperature": 0.7,
    "max_tokens": 1000
  }'

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1699000000,
  "model": "gpt-3.5-turbo",
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "Hello! How can I help you today?"
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 10,
    "total_tokens": 30
  }
}

​

2. Text Completions

POST /v1/completions

​

3. Embeddings

POST /v1/embeddings

curl -X POST "https://api.apiyi.com/v1/embeddings" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "text-embedding-ada-002",
    "input": "This is a text example for vectorization"
  }'

​

4. Image Generation

POST /v1/images/generations

curl -X POST "https://api.apiyi.com/v1/images/generations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-1",
    "prompt": "A cute orange kitten sitting in a sunny garden",
    "n": 1,
    "size": "1024x1024",
    "quality": "hd"
  }'

​

5. Audio Transcription

POST /v1/audio/transcriptions

​

6. Model List

GET /v1/models

{
  "object": "list",
  "data": [
    {
      "id": "gpt-3.5-turbo",
      "object": "model",
      "created": 1677610602,
      "owned_by": "openai"
    },
    {
      "id": "gpt-4o",
      "object": "model",
      "created": 1687882411,
      "owned_by": "openai"
    }
  ]
}

​

Streaming Response

​

Enable Streaming Output

{
  "model": "gpt-3.5-turbo",
  "messages": [{"role": "user", "content": "Hello"}],
  "stream": true
}

​

Streaming Response Format

data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1699000000,"model":"gpt-3.5-turbo","choices":[{"delta":{"content":"Hello"},"index":0}]}

data: {"id":"chatcmpl-123","object":"chat.completion.chunk","created":1699000000,"model":"gpt-3.5-turbo","choices":[{"delta":{"content":" there"},"index":0}]}

data: [DONE]

​

Handle Streaming Response

import requests
import json

response = requests.post(
    'https://api.apiyi.com/v1/chat/completions',
    headers={
        'Authorization': f'Bearer {api_key}',
        'Content-Type': 'application/json'
    },
    json={
        'model': 'gpt-3.5-turbo',
        'messages': [{'role': 'user', 'content': 'Hello'}],
        'stream': True
    },
    stream=True
)

for line in response.iter_lines():
    if line:
        line = line.decode('utf-8')
        if line.startswith('data: '):
            data = line[6:]
            if data != '[DONE]':
                chunk = json.loads(data)
                content = chunk['choices'][0]['delta'].get('content', '')
                print(content, end='')

​

Error Handling

​

Error Response Format

{
  "error": {
    "message": "Invalid API key provided",
    "type": "invalid_request_error",
    "param": null,
    "code": "invalid_api_key"
  }
}

​

Common Error Codes

​

Error Handling Example

try:
    response = client.chat.completions.create(
        model="gpt-3.5-turbo",
        messages=[{"role": "user", "content": "Hello"}]
    )
except Exception as e:
    if hasattr(e, 'status_code'):
        if e.status_code == 401:
            print("Invalid API key")
        elif e.status_code == 429:
            print("Request too frequent or insufficient quota")
        elif e.status_code == 500:
            print("Server error, please try again later")
    else:
        print(f"Unknown error: {str(e)}")

​

Best Practices

​

1. Request Optimization

• Set max_tokens reasonably: Avoid unnecessarily long outputs
• Use temperature: Control output randomness
• Batch processing: Merge multiple requests to reduce calls

​

2. Error Retry

import time
import random

def retry_with_backoff(func, max_retries=3):
    for i in range(max_retries):
        try:
            return func()
        except Exception as e:
            if i == max_retries - 1:
                raise e
            wait_time = (2 ** i) + random.uniform(0, 1)
            time.sleep(wait_time)

​

3. Security Recommendations

• Protect API keys: Use environment variables for storage
• Limit permissions: Create different keys for different applications
• Monitor usage: Regularly check API usage logs

​

4. Performance Optimization

• Use streaming output: Improve user experience
• Cache responses: Cache results for identical requests
• Concurrency control: Reasonably control concurrent request count

​

Rate Limits

​

Need Help?

• View Complete API Documentation
• Visit APIYI Website
• Contact technical support: [email protected]