​
Welcome

Welcome to the YEScale AI API Reference. This documentation provides detailed information on how to interact with our APIs to leverage the full power of OpenAI’s capabilities through our reverse proxy service.

YEScale AI offers a comprehensive suite of APIs designed to manage your account, track usage, and access various AI functionalities provided by OpenAI. Whether you are looking to create tokens, check API usage, or generate AI-driven content, our APIs are here to support your needs.

​
How to Use the API

To use the YEScale AI APIs, you must include an API key in your requests. Follow the steps below to get started:

  1. Obtain an API Key:

    • Visit YEScale.one to create a new API key.
    • Navigate to the API Keys section and generate a new key.

  2. Include the API Key in Your Requests:

    • For authentication, include the API key in the Authorization header of your HTTP requests.
    • Example:
      example.sh
         curl --location 'https://yescale.one/v1/chat/completions' \
   --header 'authorization: Bearer <enter_your_api_key>' \
   --header 'content-type: application/json' \
   --data '{
       "messages": [
           {
               "role": "system",
               "content": "You are a helpful assistant"
           },
           {
               "role": "user",
               "content": "Hello"
           }
       ],
       "model": "gpt-4o",
       "max_tokens": 400,
       "stream": false
   }'

​
API Groups

Our API is divided into two main groups to help you manage your resources and utilize OpenAI’s functionalities effectively:

​
Group 1: YEScale Management API

  1. Create Token: Generate a new token for accessing the API.
  2. Check API Usage: Retrieve details about your API usage and monitor your consumption.
  3. Track Balance: Check your account balance and manage your credits.

​
Group 2: OpenAI Relay API

  1. Chat Completions: Interact with the ChatGPT model to get conversational responses.
  2. Completions: Generate text completions based on a given prompt.
  3. Embeddings: Create text embeddings for semantic search and other applications.
  4. Image Generations: Generate images using DALL·E.
  5. TTS & Whisper: Utilize text-to-speech and speech-to-text functionalities.

For detailed information on each API endpoint, including request parameters, response formats, and examples, please refer to the respective sections in this documentation.

​
Online Customer Service

Our platform provides professional customer service, ensuring comprehensive pre-sales consultation and reliable after-sales support.

For more information, please visit our official website.

Authentication