> For the complete documentation index, see [llms.txt](https://docs.nebulablock.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nebulablock.com/api-reference.md).

# API Reference

- [Overview](https://docs.nebulablock.com/api-reference/api-reference.md): Reference for Nebula Block's two APIs — the OpenAI-compatible Inference API and the Platform API.
- [Authentication](https://docs.nebulablock.com/api-reference/authentication.md): Authenticate to Nebula Block with an API key or a login access token, and manage key rotation.
- [Inference API](https://docs.nebulablock.com/api-reference/inference-api.md): The OpenAI-compatible Inference API: chat completions, vision, images, video, embeddings, and reranking.
- [List Models](https://docs.nebulablock.com/api-reference/inference-api/list-models.md): List the models available on Nebula Block, either OpenAI-style or with full catalog metadata and per-tier limits.
- [Chat Completions](https://docs.nebulablock.com/api-reference/inference-api/chat-completions.md): Generate chat completions with Nebula Block's text and multimodal models through the OpenAI-compatible API.
- [Vision](https://docs.nebulablock.com/api-reference/inference-api/vision.md): Send images alongside text to Nebula Block's vision and multimodal models and get a text response.
- [Images](https://docs.nebulablock.com/api-reference/inference-api/images.md): Generate and edit images through Nebula Block's OpenAI-compatible images endpoints.
- [Videos](https://docs.nebulablock.com/api-reference/inference-api/videos.md): Submit, poll, and stream asynchronous video generations on Nebula Block.
- [Embeddings](https://docs.nebulablock.com/api-reference/inference-api/embeddings.md): Turn text into embedding vectors for semantic search and retrieval on Nebula Block.
- [Rerank](https://docs.nebulablock.com/api-reference/inference-api/rerank.md): Score documents against a query and return them ranked by relevance.
- [Platform API](https://docs.nebulablock.com/api-reference/platform-api.md): The Platform API for managing Nebula Block instances, SSH keys, API keys, object storage, and billing.
- [Instances](https://docs.nebulablock.com/api-reference/platform-api/list-products.md): List the GPU and CPU instance configurations available to rent, with hardware specs and hourly pricing.
- [List OS Images](https://docs.nebulablock.com/api-reference/platform-api/list-products/list-os-images.md): List the operating system images in the Nebula Block catalog.
- [Create Instance](https://docs.nebulablock.com/api-reference/platform-api/list-products/create-instance.md): Deploy a new GPU or CPU instance with your chosen hardware, OS image, and SSH key.
- [List Instances](https://docs.nebulablock.com/api-reference/platform-api/list-products/list-instances.md): List the instances currently running on your Nebula Block account.
- [List Deleted Instances](https://docs.nebulablock.com/api-reference/platform-api/list-products/list-deleted-instances.md): List instances that have been deleted from your Nebula Block account.
- [Get Instance](https://docs.nebulablock.com/api-reference/platform-api/list-products/get-instance.md): Retrieve the full details of one instance, including its connection credentials.
- [Start Instance](https://docs.nebulablock.com/api-reference/platform-api/list-products/start-instance.md): Power on a stopped Nebula Block instance.
- [Stop Instance](https://docs.nebulablock.com/api-reference/platform-api/list-products/stop-instance.md): Power off a running Nebula Block instance. Billing continues while the instance exists.
- [Reboot Instance](https://docs.nebulablock.com/api-reference/platform-api/list-products/reboot-instance.md): Reboot a running Nebula Block GPU or CPU instance without terminating it.
- [Delete Instance](https://docs.nebulablock.com/api-reference/platform-api/list-products/delete-instance.md): Permanently terminate a Nebula Block instance and stop its hourly billing.
- [Firewall Rules](https://docs.nebulablock.com/api-reference/platform-api/list-products/firewall-rules.md): List, add, and delete per-instance firewall rules on a Nebula Block GPU or CPU instance.
- [SSH Keys](https://docs.nebulablock.com/api-reference/platform-api/list-ssh-keys.md): List the SSH public keys registered on your Nebula Block account.
- [Create SSH Key](https://docs.nebulablock.com/api-reference/platform-api/list-ssh-keys/create-ssh-key.md): Register an SSH public key so you can log into your GPU instances.
- [Rename SSH Key](https://docs.nebulablock.com/api-reference/platform-api/list-ssh-keys/rename-ssh-key.md): Rename an SSH public key registered on your Nebula Block account.
- [Delete SSH Key](https://docs.nebulablock.com/api-reference/platform-api/list-ssh-keys/delete-ssh-key.md): Delete an SSH public key from your Nebula Block account.
- [API Keys](https://docs.nebulablock.com/api-reference/platform-api/list-api-keys.md): Retrieve every API key on your Nebula Block account, including its name, status, and team.
- [Create API Key](https://docs.nebulablock.com/api-reference/platform-api/list-api-keys/create-api-key.md): Create a new Nebula Block API key, optionally scoped to a team.
- [Update API Key](https://docs.nebulablock.com/api-reference/platform-api/list-api-keys/update-api-key.md): Change an API key's description, or disable and re-enable it.
- [Delete API Key](https://docs.nebulablock.com/api-reference/platform-api/list-api-keys/delete-api-key.md): Permanently delete a Nebula Block API key. Applications using it stop authenticating immediately.
- [Object Storage](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces.md): List your Nebula Block object storage workspaces, with status, charges, and pagination.
- [Create Storage Workspace](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/create-workspace.md): Provision a new object storage workspace and its S3 access key pair.
- [Delete Storage Workspace](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/delete-workspace.md): Delete an object storage workspace and invalidate its access keys.
- [Regenerate Access Keys](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/regenerate-key-pair.md): Issue a new S3 access key pair for a workspace and invalidate the previous one.
- [List Buckets](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/list-buckets.md): List the buckets in an object storage workspace with object counts, sizes, and privacy.
- [Create Bucket](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/create-bucket.md): Create a bucket inside a Nebula Block object storage workspace.
- [Delete Bucket](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/delete-bucket.md): Delete a bucket from a Nebula Block object storage workspace.
- [List Files](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/list-files.md): List the objects in a bucket. Returns at most 1,000 entries and does not paginate.
- [Upload File](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/upload-file.md): Upload a file into a bucket through the Platform API using multipart form data.
- [Get Download URL](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/get-download-url.md): Get a download URL for an object, pre-signed and expiring when the bucket is private.
- [Delete File](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/delete-file.md): Delete one or more objects from a bucket in a single batched call.
- [Toggle Bucket Privacy](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/toggle-bucket-privacy.md): Flip a bucket between public and private, which determines whether download URLs are signed.
- [Get Storage Usage](https://docs.nebulablock.com/api-reference/platform-api/list-workspaces/get-usage.md): Read storage and transfer usage for a workspace over the last 24 hours, 7 days, and 30 days.
- [Billing](https://docs.nebulablock.com/api-reference/platform-api/get-credit-balance.md): Retrieve your current Nebula Block credit balance.
- [List Invoices](https://docs.nebulablock.com/api-reference/platform-api/get-credit-balance/list-invoices.md): List the invoices generated for your Nebula Block credit purchases.
- [Download Invoice](https://docs.nebulablock.com/api-reference/platform-api/get-credit-balance/download-invoice.md): Download a Nebula Block invoice by its ID.
- [Get Payment History](https://docs.nebulablock.com/api-reference/platform-api/get-credit-balance/get-payment-history.md): Retrieve the history of credit purchases and deductions on your account.