Skip to main content

Base URL

All API requests are sent to:
https://ai.alad.com

Authentication

Starrise AI uses Bearer Token authentication. Include your API key in the Authorization header of every request:
Authorization: Bearer YOUR_API_KEY
You can generate and manage API keys in the Console.
Keep your API key secure. Do not expose it in client-side code or public repositories.

Request Format

All requests must use Content-Type: application/json with a JSON-encoded request body.
curl https://ai.alad.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-3-5-sonnet-20241022",
    "messages": [
      {"role": "user", "content": "Hello!"}
    ]
  }'

Supported Endpoints

EndpointDescription
POST /v1/chat/completionsChat completion (OpenAI-compatible)
POST /v1/images/generationsImage generation (ByteDance Seedream)
POST /v1/video/generationsVideo generation (ByteDance Seedance)
GET /v1/video/generations/{id}Query video generation task status
POST /kling/v1/videos/text2videoKuaishou Kling text-to-video
POST /kling/v1/videos/image2videoKuaishou Kling image-to-video
POST /kling/v1/videos/multi-image2videoKuaishou Kling multi-image-to-video
GET /kling/v1/videos/{id}Query Kling task status

Response Format

All responses are JSON-encoded. Successful responses typically contain:
{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "model": "claude-3-5-sonnet-20241022",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello! How can I help you?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 10,
    "completion_tokens": 12,
    "total_tokens": 22
  }
}

Error Handling

When an error occurs, the API returns a JSON response containing an error object:
{
  "error": {
    "message": "The provided API key is invalid.",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

HTTP Status Codes

Status CodeDescription
200Success
400Bad Request — invalid parameters
401Unauthorized — API key missing or invalid
403Forbidden — insufficient permissions
404Not Found — invalid endpoint
429Rate Limit Exceeded — too many requests
500Internal Server Error

Rate Limits

Rate limits vary by model and subscription tier. When rate limits are exceeded, the API returns a 429 status code. We recommend implementing exponential backoff to handle rate limits gracefully.

OpenAI SDK Compatibility

Starrise AI is compatible with the OpenAI SDK. Simply change the base_url to use it:
from openai import OpenAI

client = OpenAI(
    api_key="YOUR_API_KEY",
    base_url="https://ai.alad.com/v1"
)