Authentication

API Key Authentication

All requests to the Yunxin API must include a valid API key in the Authorization header using the Bearer token scheme:

Authorization: Bearer YOUR_API_KEY

Creating API Keys

1. Log in to your Dashboard
2. Navigate to API Keys
3. Click Create API Key
4. Give your key a descriptive name (e.g., "Production Server", "Development")
5. Copy and securely store the key — it will only be shown once

Key Permissions

Each API key inherits the permissions of your account:

Key Management

You can manage your API keys from the Dashboard:

• Revoke — Immediately invalidate a compromised key
• Regenerate — Create a new key with the same configuration
• View Usage — Monitor per-key usage statistics

Security Best Practices

Do

• Store API keys in environment variables
• Use server-side proxy for API calls from frontend applications
• Rotate keys periodically
• Use separate keys for development and production
• Monitor key usage for anomalies

Don't

• Hardcode API keys in source code
• Commit .env files to version control
• Share API keys over insecure channels
• Use the same key across all environments

Request Example

curl https://api.yuhuanstudio.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer yx-abc123def456" \
  -d '{"model": "model-id", "messages": [{"role": "user", "content": "Hi"}]}'

import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["YUNXIN_API_KEY"],
    base_url="https://api.yuhuanstudio.com/v1"
)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.YUNXIN_API_KEY,
  baseURL: "https://api.yuhuanstudio.com/v1",
});

Authentication Errors