> ## Documentation Index
> Fetch the complete documentation index at: https://docs.phanomcloud.online/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Welcome to the PhanomCloud API — host and manage your bots in the cloud.

<img className="block dark:hidden" alt="Banner Phanom" title="Banner Phanom" src="https://mintcdn.com/phanomcloud/iMJWJnmSl_qQdvWB/images/banner-phanom.jpg?fit=max&auto=format&n=iMJWJnmSl_qQdvWB&q=85&s=58370a1ff898b1b234a74ac48a8fde02" width="1536" height="586" data-path="images/banner-phanom.jpg" />

<img className="hidden dark:block" alt="Banner Phanom" title="Banner Phanom" src="https://mintcdn.com/phanomcloud/iMJWJnmSl_qQdvWB/images/banner-phanom.jpg?fit=max&auto=format&n=iMJWJnmSl_qQdvWB&q=85&s=58370a1ff898b1b234a74ac48a8fde02" width="1536" height="586" data-path="images/banner-phanom.jpg" />

## What is PhanomCloud?

PhanomCloud is a cloud hosting platform for bots and applications. With our API you can create, start, stop, monitor and manage your bots programmatically — perfect for CI/CD pipelines, dashboards and automation tools.

## Base URL

All API requests must be made to:

```text theme={null}
https://api.phanomcloud.online
```

## Response Format

Every endpoint returns a JSON object in one of these two shapes:

<CodeGroup>
  ```json Success theme={null}
  {
    "success": true,
    "data": { ... },
    "message": "Optional human-readable message"
  }
  ```

  ```json Error theme={null}
  {
    "success": false,
    "error": "Description of what went wrong"
  }
  ```
</CodeGroup>

## Quick Start

<Steps>
  <Step title="Get your session token">
    Authenticate via Discord OAuth2 and store your `session_token`.
  </Step>

  <Step title="Create a bot">
    Call `POST /bots/create` with your bot name, language and memory.
  </Step>

  <Step title="Upload your code">
    Upload a `.zip` or `.rar` with your bot files via `POST /bots/:id/upload`.
  </Step>

  <Step title="Start the bot">
    Call `POST /bots/start` and your bot will be running in seconds.
  </Step>
</Steps>

## Supported Languages

| Language | Value    |
| -------- | -------- |
| Node.js  | `nodejs` |
| Python   | `python` |
| Java     | `java`   |
| Go       | `go`     |
| Rust     | `rust`   |

## Bot Status Reference

| Status     | Description                             |
| ---------- | --------------------------------------- |
| `offline`  | Bot is stopped                          |
| `starting` | Container is being created and launched |
| `online`   | Bot is running normally                 |
| `stopping` | Bot is in the process of shutting down  |
| `error`    | Bot failed to start                     |