# Hivenet Docs

- [Welcome to Hivenet Docs](https://docs.hivenet.com/index.md): Start here for Hivenet technical documentation covering Compute, Hivenet Inference API, organizations, billing, connectivity, and public APIs.
- [Welcome to Compute with Hivenet](https://docs.hivenet.com/about-hivenet.md): Understand how Compute uses organizations, prepaid credits, containers, virtual machines, and distributed GPU and CPU infrastructure.
- [Compute quickstart](https://docs.hivenet.com/quickstart.md): Create your first Compute container or virtual machine, pick hardware and connection settings, review costs, and connect from your organization.
- [Launch and connect to your first Compute instance](https://docs.hivenet.com/documentation/essentials/create-instance.md): Pick an organization, configure a Compute container or virtual machine, choose SSH or web access, review cost, and connect once it reaches Running.
- [Understand and choose your Compute instance](https://docs.hivenet.com/documentation/essentials/understand-choose-instance.md): A practical guide to choosing, launching, and connecting to the right Compute with Hivenet instance based on your GPU, CPU, RAM, and storage needs.
- [Choosing between a virtual machine and a container](https://docs.hivenet.com/documentation/essentials/choosing-between-a-virtual-machine-and-a-container.md): Compare Compute virtual machines and containers, and pick the instance type that matches how much OS control, isolation, and packaging your workload needs.
- [How to use custom templates](https://docs.hivenet.com/documentation/essentials/custom-templates.md): Create, save, and reuse custom Compute with Hivenet templates so you can launch instances with your own container image, ports, and environment settings.
- [How to start and stop your Compute instances](https://docs.hivenet.com/documentation/essentials/start-stop-instances.md): Start and stop Compute with Hivenet instances from the dashboard to pause usage without losing progress and only pay while an instance is running.
- [How to stop or terminate a Compute instance on Hivenet](https://docs.hivenet.com/documentation/essentials/stop-terminate-instance.md): Compare Stop and Terminate for Compute with Hivenet instances, understand what each action keeps or deletes, and pick the safest option for your workload.
- [Using vCPUs](https://docs.hivenet.com/documentation/essentials/how-to-vcpu.md): Learn how vCPUs work on Compute with Hivenet, when to pick a CPU-only instance over a GPU, and which vCPU, RAM, and disk sizes are available.
- [Compute account settings and preferences](https://docs.hivenet.com/documentation/essentials/general-settings.md): Manage personal Compute preferences, SSH keys, appearance and language options, organization access, and account deletion from the account menu.
- [Hivenet Inference API overview](https://docs.hivenet.com/documentation/inference-api/overview.md): Learn how Hivenet Inference API serves open-weight models as managed, OpenAI-compatible endpoints with fixed replicas and shared Compute billing.
- [Get started with Hivenet Inference API](https://docs.hivenet.com/documentation/inference-api/get-started.md): Deploy a managed model endpoint, create an Inference API key, and send your first OpenAI-compatible Chat Completions request from the Hivenet Compute console.
- [Choose an Inference API model and variant](https://docs.hivenet.com/documentation/inference-api/models-and-variants.md): Compare Inference API models and serving variants by capabilities, context window, latency, request capacity, and per-replica hourly cost.
- [Create and manage Inference API keys](https://docs.hivenet.com/documentation/inference-api/api-keys.md): Create organization-scoped Inference API keys, save the one-time secret, and disable, re-enable, or revoke access without stopping your endpoints.
- [Call your Inference API endpoint](https://docs.hivenet.com/documentation/inference-api/call-your-endpoint.md): Send OpenAI-compatible Chat Completions requests with Python, JavaScript, or curl using your endpoint URL, model value, and Inference API key.
- [Manage an Inference API endpoint](https://docs.hivenet.com/documentation/inference-api/manage-deployments.md): Understand Inference API endpoint states, view endpoint details, and safely start, stop, retry, terminate, clear, or resize an endpoint.
- [Manage replicas and Inference API capacity](https://docs.hivenet.com/documentation/inference-api/replicas-and-capacity.md): Understand fixed replicas, requested versus active capacity, live scaling limits, and how replica count affects throughput and cost.
- [Understand Inference API billing](https://docs.hivenet.com/documentation/inference-api/billing.md): Understand per-replica pricing, per-second billing, shared organization credits, and when Inference API charges start, change, pause, and stop.
- [Troubleshoot Hivenet Inference API](https://docs.hivenet.com/documentation/inference-api/troubleshooting.md): Fix common Inference API problems with location capacity, credits, endpoint states, replicas, API keys, endpoint URLs, and model identifiers.
- [How organizations work in Compute](https://docs.hivenet.com/documentation/organizations/how-organizations-work.md): Understand how Compute organizations group people, Owner, Admin, and Member roles, shared credit balance, instances, and billing under one account.
- [Invite people and manage organization roles](https://docs.hivenet.com/documentation/organizations/invite-people-manage-roles.md): Invite Admins and Members to your Compute organization, track pending invitations, change roles, and remove access as an Owner or Admin.
- [Join or leave a Compute organization](https://docs.hivenet.com/documentation/organizations/join-leave-organization.md): Accept or decline a Compute organization invitation, prepare your account and existing credits for the move, and leave an organization safely.
- [Transfer ownership or delete an organization](https://docs.hivenet.com/documentation/organizations/transfer-ownership-delete-organization.md): Transfer Owner control of a Compute organization to another Admin, or permanently delete the organization along with its instances, credits, and access.
- [How can I connect to a Compute instance from macOS?](https://docs.hivenet.com/documentation/connectivity/connect-instance-macos.md): Connect to a Compute with Hivenet instance from macOS using the built-in Terminal and ssh command, including first-login steps and known_hosts prompts.
- [How can I connect to a Compute instance from Windows?](https://docs.hivenet.com/documentation/connectivity/connect-instance-windows.md): Connect to a Compute with Hivenet instance from Windows using PowerShell or the built-in OpenSSH client, from first login to a working shell prompt.
- [Agent network and firewall basics](https://docs.hivenet.com/documentation/connectivity/firewall-basics.md): Learn what the Hivenet Agent does, which ports and hosts it needs, and how to configure your firewall to avoid Compute connection and login issues.
- [How to forward ports to reach your web app](https://docs.hivenet.com/documentation/connectivity/forwards-ports.md): Forward ports over SSH to reach web UIs, Jupyter, or APIs running on your Compute instance from your local browser without exposing them publicly.
- [Serve an HTTPS site with SSH port forwarding](https://docs.hivenet.com/documentation/connectivity/https-site-ssh-port-forwarding.md): Run python -m http.server or your own web app on a Compute instance and reach it locally over an encrypted SSH tunnel, without public exposure.
- [How to generate and add an SSH key on Linux](https://docs.hivenet.com/documentation/connectivity/ssh-key-linux.md): Generate an ed25519 SSH key on Linux with ssh-keygen and add the public key to Compute with Hivenet so you can connect to instances securely.
- [How to generate and add an SSH key on macOS](https://docs.hivenet.com/documentation/connectivity/ssh-key-macos.md): Generate an ed25519 SSH key on macOS with ssh-keygen and add the public key to Compute with Hivenet so you can connect to instances securely.
- [How can I generate and add an SSH key on Windows?](https://docs.hivenet.com/documentation/connectivity/ssh-key-windows.md): Generate an SSH key on Windows using PowerShell or PuTTYgen and add the public key to Compute with Hivenet to connect to instances securely.
- [SSH into a Compute instance from Windows](https://docs.hivenet.com/documentation/connectivity/ssh-puttygen-openssh.md): Convert a PuTTYgen private key to OpenSSH format and connect to your Compute instance from Windows using the built-in ssh command.
- [Transfer files to and from your Compute instance with SFTP](https://docs.hivenet.com/documentation/file-transfer/transfer-files-sftp.md): Move files to and from a Compute with Hivenet instance over SFTP using the sftp CLI, WinSCP, or FileZilla, with example commands and connection settings.
- [Troubleshoot 'invalid SSH key' upload errors](https://docs.hivenet.com/documentation/troubleshooting/invalid-SSH-key.md): Fix 'invalid SSH key' errors when adding your public key to Compute with Hivenet, including format, key type, and copy-paste mistakes to check.
- [How to get your instance ID](https://docs.hivenet.com/documentation/troubleshooting/get-instance-id.md): Find and copy your Compute with Hivenet instance ID from the dashboard so you can reference it in support requests, API calls, and troubleshooting.
- [Fix certificate and HTTPS warnings on Compute](https://docs.hivenet.com/documentation/troubleshooting/certificate-errors.md): Resolve certificate or HTTPS warnings on Compute with Hivenet caused by corporate firewalls, antivirus HTTPS scanning, or outdated system root certificates.
- [Compute instance URLs and Bad Gateway errors](https://docs.hivenet.com/documentation/troubleshooting/bad-gateway-errors.md): Troubleshoot Bad Gateway errors on Compute with Hivenet instance URLs, including common causes tied to instance status, ports, and app startup.
- [Billing information](https://docs.hivenet.com/documentation/account-billing/billing-info.md): Learn how organization credits, billing roles, payment methods, auto top-up, invoices, and transaction history work for Compute organizations.
- [Track organization spending in real time](https://docs.hivenet.com/documentation/account-billing/track-costs-real-time.md): Monitor your organization's credit balance, spend rate, and active resource costs in real time from the Compute console and Billing page.
- [Delete your Compute account](https://docs.hivenet.com/documentation/account-billing/delete-account.md): Prepare your organization membership, transfer ownership, terminate remaining instances, and permanently delete your personal Compute account from Hivenet.
- [Frequently asked questions](https://docs.hivenet.com/documentation/reference/faq.md): Answers to frequently asked questions about Compute with Hivenet instances, GPUs, billing, credits, SSH access, and troubleshooting common issues.
- [Glossary](https://docs.hivenet.com/documentation/reference/glossary.md): Alphabetical glossary of Compute with Hivenet terms, from instance and vLLM to SSH, SFTP, and vCPU, with short plain-English definitions.
- [GPU types and sizes](https://docs.hivenet.com/documentation/reference/gpu-types.md): Reference for the current Compute with Hivenet GPU fleet, including RTX 5090 memory, available multi-GPU sizes, and where to check live preset details.
- [CPU-only types and sizes](https://docs.hivenet.com/documentation/reference/cpu-types.md): Reference for CPU-only Compute with Hivenet instances on AMD EPYC 7713 hosts, with fixed vCPU, RAM, disk, and bandwidth options for each size.
- [Choose a Compute configuration for image generation](https://docs.hivenet.com/tutorials/how-to/configuration-image-generation.md): Choose a Compute GPU configuration for Stable Diffusion, Flux, ComfyUI, Fooocus, and similar image-generation workloads based on VRAM and parallelism needs.
- [How can I open a Jupyter notebook with Compute?](https://docs.hivenet.com/tutorials/how-to/open-jupyter-notebook.md): Launch a Compute with Hivenet instance and open a Jupyter notebook in your browser using the built-in template, without SSH or command-line setup.
- [How to install Docker on a Compute VM](https://docs.hivenet.com/tutorials/how-to/install-docker.md): Launch a Compute virtual machine, connect over SSH, install Docker Engine on Ubuntu, Debian, or Fedora, and verify the daemon runs a hello-world container.
- [Expose a service from a Compute VM: SSH, HTTPS, TCP, and UDP](https://docs.hivenet.com/tutorials/how-to/expose-a-service-from-a-compute-vm-ssh-https-tcp-and-udp.md): Compare the four connectivity options for Compute virtual machines—SSH, HTTPS, TCP, and UDP—and choose the right one for exposing your service.
- [Why Compute supports SFTP—not FTPS](https://docs.hivenet.com/tutorials/more-guides/sftp-not-ftps.md): Understand why Compute with Hivenet supports SFTP instead of FTPS, how the two protocols differ, and how to adjust file-transfer workflows accordingly.
- [The SSH config file, known_hosts, and identity files](https://docs.hivenet.com/tutorials/more-guides/SSH-config-file-explained.md): Understand what lives inside your .ssh folder, how known_hosts and identity files work, and how the SSH config file simplifies connecting to Compute instances.
- [Choosing between GPU and vCPU instances](https://docs.hivenet.com/tutorials/more-guides/choosing-between-cpu-gpu.md): Compare Compute with Hivenet GPU and vCPU instances, understand cost and performance trade-offs, and pick the right type for training or CPU workloads.
- [Get started with the Compute API](https://docs.hivenet.com/public-api/get-started-with-the-compute-api.md): Understand how the Compute API authenticates requests, what base URL to use, and where to find endpoint reference details for building integrations.
- [Make your first API request](https://docs.hivenet.com/public-api/make-your-first-api-request.md): Send a read-only GET request to the Compute API to verify your API key, base URL, and JSON response handling before making state-changing calls.
- [Authenticate API requests](https://docs.hivenet.com/public-api/authenticate-api-requests.md): Learn how to authenticate Compute API requests with a bearer token, where to generate API keys, and how to handle 401 and 403 responses in your integration.
- [Work with instances](https://docs.hivenet.com/public-api/work-with-instances.md): Manage existing Compute instances through the API: list, inspect, read logs, and start, stop, or terminate them across their lifecycle statuses.
- [Use pagination and filters](https://docs.hivenet.com/public-api/use-pagination-and-filters.md): Page through Compute API list results with cursor pagination and narrow responses using supported filter query parameters like status and region.
- [Handle errors and rate limits](https://docs.hivenet.com/public-api/handle-errors-and-rate-limits.md): Reference for Compute API error responses, HTTP status codes, retry guidance, and per-IP rate limits so your integration handles failures reliably.
- [List instances](https://docs.hivenet.com/public-api/endpoints/list-instances.md): Returns a cursor-paginated list of your instances, newest first.
- [Get instance](https://docs.hivenet.com/public-api/endpoints/get-instance.md): Returns the full detail of one of your instances.
- [Get instance logs](https://docs.hivenet.com/public-api/endpoints/get-instance-logs.md): Returns recent console output from one of your instances, **newest line first** (the same order as `kubectl logs --tail`). The window reaches back at most 10 hours; older output is not retrievable through this endpoint.
- [Start instance](https://docs.hivenet.com/public-api/endpoints/start-instance.md): Starts a stopped instance. The call returns as soon as the request is accepted; the instance moves `STARTING → RUNNING` in the background, so poll `GET /instances/{id}` to observe the transition.
- [Stop instance](https://docs.hivenet.com/public-api/endpoints/stop-instance.md): Stops a running instance. The call returns as soon as the request is accepted; the instance moves `STOPPING → STOPPED` in the background.
- [Terminate instance](https://docs.hivenet.com/public-api/endpoints/terminate-instance.md): Permanently destroys an instance and its storage.
- [List regions](https://docs.hivenet.com/public-api/endpoints/list-regions.md): Returns the region codes used across the API. Use a region's `name` as the `region` filter on `GET /presets` and `GET /instances`.
- [List presets](https://docs.hivenet.com/public-api/endpoints/list-presets.md): Returns a cursor-paginated list of the hardware configurations instances can run on, with their hourly price.
- [List your instances](https://docs.hivenet.com/api-reference/instances/list-your-instances.md): Returns a cursor-paginated list of your instances, newest first.
- [Get an instance](https://docs.hivenet.com/api-reference/instances/get-an-instance.md): Returns the full detail of one of your instances.
- [Read an instance's logs](https://docs.hivenet.com/api-reference/instances/read-an-instances-logs.md): Returns recent console output from one of your instances, **newest line first** (the same order as `kubectl logs --tail`). The window reaches back at most 10 hours; older output is not retrievable through this endpoint.
- [Start an instance](https://docs.hivenet.com/api-reference/instances/start-an-instance.md): Starts a stopped instance. The call returns as soon as the request is accepted; the instance moves `STARTING → RUNNING` in the background, so poll `GET /instances/{id}` to observe the transition.
- [Stop an instance](https://docs.hivenet.com/api-reference/instances/stop-an-instance.md): Stops a running instance. The call returns as soon as the request is accepted; the instance moves `STOPPING → STOPPED` in the background.
- [Terminate an instance](https://docs.hivenet.com/api-reference/instances/terminate-an-instance.md): Permanently destroys an instance and its storage.
- [List regions](https://docs.hivenet.com/api-reference/catalogue/list-regions.md): Returns the region codes used across the API. Use a region's `name` as the `region` filter on `GET /presets` and `GET /instances`.
- [List hardware presets](https://docs.hivenet.com/api-reference/catalogue/list-hardware-presets.md): Returns a cursor-paginated list of the hardware configurations instances can run on, with their hourly price.
- [API changelog](https://docs.hivenet.com/public-api/api-changelog.md): Track Compute API changes that may affect your integration, including new endpoints, request and response changes, authentication updates, and deprecations.
- [Changelog](https://docs.hivenet.com/changelog.md): Product updates and announcements for Compute with Hivenet, including new API endpoints, guides, and platform changes for developers.

## OpenAPI Specs

- [public-v1](/public-v1.yaml)

## Optional

- [Console](https://console.hivecompute.ai/)
- [Help Center](https://help.hivenet.com/en/)
- [Community](https://discord.com/invite/p2CwYSKsQU)
- [Blog](https://compute.hivenet.com/computes-blog)