YEScale System API Tutorial

This tutorial will guide you through the process of integrating with the YEScale System API. You will learn how to retrieve user information, manage your API keys, track your tasks, and access system logs.

Base URL: https://yescale.bogia.app

Prerequisites

Authentication

API Endpoints

3.1 Get User Information

3.2 List API Keys

3.3 List Tasks

3.4 Get Logs

1. Prerequisites

Before you begin, ensure you have the following:

Access Key: Obtain your unique Access Key from your YEScale account's home page. This key is essential for authenticating your API requests.

2. Authentication

All requests to the YEScale System API require authentication. You must include your Access Key in the Authorization header for most endpoints.

Header Format:

Authorization: Bearer ACCESS_KEY

Replace ACCESS_KEY with your actual Access Key.

3. API Endpoints

The following sections detail the available API endpoints and how to use them.

3.1 Get User Information

Retrieve detailed information about your YEScale user account.

Endpoint: /yescale/user

Method: GET

Headers:

Authorization: Bearer ACCESS_KEY (Replace ACCESS_KEY)

Example Request:

Example Response:

{
    "data": {
        "access_token": "XXXXX",
        "display_name": "Your Display Name",
        "email": "your.email@example.com",
        "quota": 8664402091,
        "request_count": 213527,
        "role": 1,
        "telegram_id": "",
        "used_quota": 1460014143,
        "username": "your_username"
    },
    "message": "",
    "success": true
}

Response Field Descriptions:

quota: Your remaining credits. To convert to USD, divide by 500,000.

used_quota: Your consumed credits. To convert to USD, divide by 500,000.

Other fields provide user profile and account details.

3.2 List API Keys

Fetch a list of all API keys associated with your YEScale account.

Endpoint: /yescale/apikeylist

Method: GET

Query Parameters:

keyword (optional): A string to filter API keys by.

token (optional): A specific token to filter by.

Headers:

Authorization: Bearer ACCESS_KEY (Replace ACCESS_KEY)

Example Request:

Example Response:

(The response will be a JSON array of API key objects, typically including the key itself and its properties.)

3.3 List Tasks

Retrieve a list of tasks executed by your account, with options to filter by time.

Endpoint: /yescale/task

Method: GET

Query Parameters:

start_timestamp (required): The Unix timestamp marking the beginning of the time range.

end_timestamp (required): The Unix timestamp marking the end of the time range.

Headers:

Authorization: Bearer ACCESS_KEY (Replace ACCESS_KEY)

Example Request:

3.4 Get Logs

Access system logs related to your API usage. You can filter logs by various parameters, including time ranges.

Endpoint: /yescale/logs

Method: GET

Query Parameters:

p (optional): Page number for pagination. Defaults to 1.

page_size (optional): Number of items per page. Defaults to 10000.

type (optional): Type of logs to retrieve (e.g., 2).

token_name (optional): Filter logs by a specific token name.

model_name (optional): Filter logs by a specific model name.

username (optional): Filter logs by username.

start_timestamp (optional): The Unix timestamp marking the beginning of the time range for logs.

end_timestamp (optional): The Unix timestamp marking the end of the time range for logs.

Headers:

Authorization: Bearer ACCESS_KEY (Replace ACCESS_KEY)

Example Request:

This tutorial provides a comprehensive overview of the YEScale System API. Remember to always keep your Access Key secure and use it responsibly.

YEScale System API Tutorial

Table of Contents#

1. Prerequisites#

2. Authentication#

3. API Endpoints#

3.1 Get User Information#

3.2 List API Keys#

3.3 List Tasks#

3.4 Get Logs#

Table of Contents

1. Prerequisites

2. Authentication

3. API Endpoints

3.1 Get User Information

3.2 List API Keys

3.3 List Tasks

3.4 Get Logs