API documentation
    API documentation
    • Introduction
    • Error guide
    • Quickstart guide
    • API Directory
      • Datacenter
      • Bucket
      • File and Folder
        • File
        • Folder
      • Region
      • Storage
        • Status
    • Welcome
      GET

    Quickstart guide

    Everabyte Cloud Storage API Quickstart Guide#

    Introduction#

    Welcome to the Everabyte Cloud Storage API. This guide will help you get started quickly with all storage plans—EverSpark, EverBlaze, and EverStream—all optimized for seamless media streaming and robust cloud storage capabilities.

    Prerequisites#

    Before beginning, ensure you have the following:
    An Everabyte Account associated with one of our storage plans:
    EverSpark: Suitable for individuals
    EverStream: Designed for startups, freelancers, and developers
    EverBlaze: Tailored for large teams
    Registered email and password credentials
    An HTTP client such as cURL, Postman, or any programming language of your choice

    Authentication#

    To use the Everabyte API, first obtain an authentication token.

    Authentication Request#

    Successful Response#

    {
      "status": 200,
      "message": "Successful connection",
      "data": {
        "accessToken": "access_Token",
        "sessionId": "user_id_session"
      }
    }
    Note: Keep your access token secure and never expose it in public code repositories.

    Using Your Token#

    Include the access token in the Authorization header for all subsequent API requests:

    Available Storage Plans#

    All API endpoints operate under the base URL:
    https://api.everabyte.io/api
    Feature availability depends on your subscription plan.

    Step 1: Obtain Your API Key#

    1.
    Log in to your Everabyte Dashboard.
    2.
    Navigate to API Settings.
    3.
    Generate and securely store your API key.
    Tip: Protect your API key and avoid exposing it publicly.

    Step 2: Set Up Your Environment#

    Use your preferred HTTP client or command-line tools like Curl. Postman and SDKs are also supported for easier integration.

    Step 3: Make Your First API Request#

    Fetch your user profile information with:

    Expected Response#

    {
        "status": 200,
        "message": "User found successfully",
        "data": {
            "id": "user_id",
            "email": "your_email@domain.com",
            "username": "my_username",
            ...
        }
    }
    This returns account details, including storage usage and file count.

    Step 4: Upload a File#

    Upload local files via POST:

    Expected Response#

    {
        "status": 200,
        "message": "File uploaded successfully.",
        "data": {...}
    }
    The response includes metadata like file ID, size, and storage URL.

    Step 5: List Files#

    List the files in storage:

    Expected Response#

    {
        "status": 200,
        "message": "",
        "data": {
            "total": 0,
            "data": []
        }
    }
    Returns a list of objects stored per bucket.

    Step 6: Download a File#

    Download a file by ID:
    Replace abc123 with your file ID to initiate download.

    Step 7: Handling Errors#

    If errors occur, the API will return relevant codes such as:
    400 Bad Request
    401 Unauthorized
    404 Not Found
    500 Internal Server Error
    Refer to the Error Handling Guide for detailed troubleshooting.

    Step 8: Next Steps#

    Explore advanced API features:
    File and folder management
    Metadata handling (tags, descriptions)
    Access control and permissions
    For full API details, visit the API Reference.

    Conclusion#

    You’ve successfully completed the quickstart. You’re now ready to automate cloud storage management and integrate Everabyte’s API into your projects confidently.
    Modified at 2025-10-02 13:23:01
    Previous
    Error guide
    Next
    API Directory
    Built with