# Lyceum Documentation

## Docs

- [Lyceum Cloud](https://docs.lyceum.technology/docs/index.md): Run Python, Docker, notebooks, and dedicated inference on managed GPU infrastructure
- [Quickstart](https://docs.lyceum.technology/docs/quickstart.md): Create an account, install the CLI or VS Code extension, and run your first job
- [Dashboard Overview](https://docs.lyceum.technology/docs/overview.md): Navigate the Lyceum Cloud dashboard
- [Runs](https://docs.lyceum.technology/docs/serverless/runs.md): Monitor and manage executions on Lyceum Cloud
- [Launch a Run](https://docs.lyceum.technology/docs/serverless/launch-run.md): Submit Python, Docker, or Docker Compose workloads
- [Secrets](https://docs.lyceum.technology/docs/serverless/secrets.md): Store environment variables and credentials for your runs
- [Webhook Callbacks](https://docs.lyceum.technology/docs/serverless/callbacks.md): Get notified when a run finishes by having Lyceum POST to your URL
- [Your VMs](https://docs.lyceum.technology/docs/instances/vms.md): Manage long-lived GPU virtual machines
- [Launch an Instance](https://docs.lyceum.technology/docs/instances/launch.md): Provision a dedicated GPU VM with SSH access
- [Dedicated Inference](https://docs.lyceum.technology/docs/inference/dedicated.md): Deploy a Hugging Face model to a dedicated GPU endpoint with autoscaling
- [Active Models](https://docs.lyceum.technology/docs/inference/active-models.md): Inspect running dedicated deployments and replica health
- [Serverless Inference](https://docs.lyceum.technology/docs/inference/serverless.md): Pay-per-request, OpenAI-compatible inference endpoints
- [Smart Routing](https://docs.lyceum.technology/docs/inference/routing.md): Automatically route prompts to the right model based on complexity
- [Coding Agents](https://docs.lyceum.technology/docs/agents/overview.md): Use Lyceum models in Claude Code, Cursor, Cline, opencode, Zed, aider and other AI coding tools
- [Claude Code](https://docs.lyceum.technology/docs/inference/claude-code.md): Use Claude Code with Lyceum's inference models
- [Cursor](https://docs.lyceum.technology/docs/inference/cursor.md): Use Cursor with Lyceum's inference models
- [opencode](https://docs.lyceum.technology/docs/agents/opencode.md): Configure opencode to use Lyceum inference models
- [GitHub Copilot](https://docs.lyceum.technology/docs/agents/github-copilot.md): Use Lyceum inference models in GitHub Copilot Chat with a custom endpoint
- [Cline](https://docs.lyceum.technology/docs/agents/cline.md): Configure the Cline VS Code extension to use Lyceum inference models
- [Roo Code](https://docs.lyceum.technology/docs/agents/roo-code.md): Configure the Roo Code VS Code extension to use Lyceum inference models
- [Kilo Code](https://docs.lyceum.technology/docs/agents/kilo-code.md): Configure the Kilo Code VS Code extension to use Lyceum inference models
- [Zed](https://docs.lyceum.technology/docs/agents/zed.md): Configure the Zed editor's agent to use Lyceum inference models
- [aider](https://docs.lyceum.technology/docs/agents/aider.md): Configure aider to pair program with Lyceum inference models
- [goose](https://docs.lyceum.technology/docs/agents/goose.md): Configure Block's goose agent to use Lyceum inference models
- [Vercel AI SDK](https://docs.lyceum.technology/docs/agents/vercel-ai-sdk.md): Build agents on Lyceum inference models with the Vercel AI SDK
- [Python Execution](https://docs.lyceum.technology/docs/workloads/python-execution.md): Run Python code and Jupyter notebooks on Lyceum Cloud from VS Code or the CLI
- [Docker Execution](https://docs.lyceum.technology/docs/workloads/docker-execution.md): Run any OCI-compatible Docker container on Lyceum Cloud, with optional GPU
- [Notebooks](https://docs.lyceum.technology/docs/workloads/notebooks.md): Launch Jupyter notebook servers on Lyceum Cloud machines
- [Clusters](https://docs.lyceum.technology/docs/workloads/clusters.md): Dedicated multi-node GPU clusters with InfiniBand networking
- [Logs](https://docs.lyceum.technology/docs/observability/logs.md): Query stdout, stderr, and platform logs from your runs
- [GPU & System Metrics](https://docs.lyceum.technology/docs/observability/metrics.md): Query per-execution GPU and system metrics from Prometheus
- [Pythia](https://docs.lyceum.technology/docs/tools/pythia.md): Automatically find the right GPU for your PyTorch workload
- [Storage](https://docs.lyceum.technology/docs/configuration/storage.md): Per-user S3-compatible bucket
- [API Keys](https://docs.lyceum.technology/docs/configuration/api-keys.md): Authenticate the CLI, scripts, and integrations
- [Machine Types](https://docs.lyceum.technology/docs/configuration/machine-types.md): GPU options for serverless workloads and VM instances
- [Organizations](https://docs.lyceum.technology/docs/account/organizations.md): Group members, share credits, and scope API keys to an org
- [Billing](https://docs.lyceum.technology/docs/account/billing.md): Credits, invoices, and execution history
- [Settings](https://docs.lyceum.technology/docs/account/settings.md): Profile, security, quotas, and account management
- [Run Python](https://docs.lyceum.technology/examples/python-basics.md): Submit Python code to Lyceum Cloud from the CLI or REST API
- [Deploy a Hugging Face Model](https://docs.lyceum.technology/examples/machine-learning.md): Stand up a dedicated inference endpoint and call it like OpenAI
- [Upload and Process Data](https://docs.lyceum.technology/examples/data-processing.md): Move files into your storage bucket and read them from a run
- [End-to-End API Workflow](https://docs.lyceum.technology/examples/api-integration.md): Authenticate, list machines, submit a run, and stream the result over the REST API
- [Run Docker Containers](https://docs.lyceum.technology/examples/docker-containers.md): Submit Docker images and Docker Compose stacks to Lyceum Cloud
- [VM Instances](https://docs.lyceum.technology/examples/vm-instances.md): Provision GPU/CPU virtual machines and run workloads on them
- [CLI Reference](https://docs.lyceum.technology/cli-reference/introduction.md): Complete reference for the lyceum command-line tool
- [API Reference](https://docs.lyceum.technology/api-reference/introduction.md): REST API for Lyceum Cloud
- [Start Compose execution](https://docs.lyceum.technology/api-reference/compose/start-compose-execution.md): Start Docker Compose execution and return direct streaming URL.
- [Complete Compose execution](https://docs.lyceum.technology/api-reference/compose/complete-compose-execution.md): Complete Docker Compose execution endpoint called after streaming finishes. Updates the Supabase record with final output and status.
- [Start Container execution](https://docs.lyceum.technology/api-reference/container/start-container-execution.md): Start Docker container execution and return direct streaming URL.
- [Complete Container execution](https://docs.lyceum.technology/api-reference/container/complete-container-execution.md): Complete Docker execution endpoint called after streaming finishes. Updates the Supabase record with final output and status.
- [Start Python execution](https://docs.lyceum.technology/api-reference/python/start-python-execution.md): Start execution and return direct streaming URL.
- [Complete Python execution](https://docs.lyceum.technology/api-reference/python/complete-python-execution.md): Complete execution endpoint called by the extension after streaming finishes. Updates the Supabase record with final output and status.
- [Get Python execution status](https://docs.lyceum.technology/api-reference/python/get-python-execution-status.md): Get the current status of an execution.
- [Start Gpu Selection](https://docs.lyceum.technology/api-reference/gpu-selection/start-gpu-selection.md): Start GPU selection execution.
- [Get Gpu Selection Status](https://docs.lyceum.technology/api-reference/gpu-selection/get-gpu-selection-status.md): Get the current status of a GPU selection execution.
- [Get execution](https://docs.lyceum.technology/api-reference/executions/get-execution.md): Get execution details.
- [Delete execution](https://docs.lyceum.technology/api-reference/executions/delete-execution.md): Delete an execution record.
- [Get execution timing](https://docs.lyceum.technology/api-reference/executions/get-execution-timing.md): Get execution timing details.
- [Abort execution](https://docs.lyceum.technology/api-reference/executions/abort-execution.md): Abort a specific execution by setting cancel=true in the database.
- [Stop execution](https://docs.lyceum.technology/api-reference/executions/stop-execution.md): Gracefully stop a running execution and mark it as completed.
- [List executions](https://docs.lyceum.technology/api-reference/executions/list-executions.md): List all non-completed executions for the active org.
- [Get execution metrics](https://docs.lyceum.technology/api-reference/executions/get-execution-metrics.md): Get GPU and system metrics from Prometheus for a specific execution.
- [Create Dedicated Deployment](https://docs.lyceum.technology/api-reference/dedicated-inference/create-dedicated-deployment.md)
- [Delete Dedicated Deployment](https://docs.lyceum.technology/api-reference/dedicated-inference/delete-dedicated-deployment.md)
- [Get Dedicated Deployment](https://docs.lyceum.technology/api-reference/dedicated-inference/get-dedicated-deployment.md): Get deployment details and all replicas.
- [List Dedicated Deployments](https://docs.lyceum.technology/api-reference/dedicated-inference/list-dedicated-deployments.md): List dedicated deployments.
- [Get Replica Logs](https://docs.lyceum.technology/api-reference/dedicated-inference/get-replica-logs.md): Return the last container logs for a failed replica (owned by the requesting user).
- [Get deployment metrics](https://docs.lyceum.technology/api-reference/dedicated-inference/get-deployment-metrics.md)
- [Get replica machine metrics](https://docs.lyceum.technology/api-reference/dedicated-inference/get-replica-machine-metrics.md): Get GPU and system metrics from Prometheus for a specific inference replica.
- [Route Prompt](https://docs.lyceum.technology/api-reference/chat-&-embeddings/route-prompt.md)
- [List Models](https://docs.lyceum.technology/api-reference/chat-&-embeddings/list-models.md)
- [Embeddings](https://docs.lyceum.technology/api-reference/chat-&-embeddings/embeddings.md)
- [Chat Completions](https://docs.lyceum.technology/api-reference/chat-&-embeddings/chat-completions.md)
- [List Models](https://docs.lyceum.technology/api-reference/image-generation/list-models.md)
- [Serve Image](https://docs.lyceum.technology/api-reference/image-generation/serve-image.md)
- [Create Generation](https://docs.lyceum.technology/api-reference/image-generation/create-generation.md)
- [List Video Models](https://docs.lyceum.technology/api-reference/video-generation/list-video-models.md)
- [Serve Video](https://docs.lyceum.technology/api-reference/video-generation/serve-video.md)
- [Create Video Generation](https://docs.lyceum.technology/api-reference/video-generation/create-video-generation.md)
- [Create Vm](https://docs.lyceum.technology/api-reference/vms/create-vm.md): Create a new VM with specified hardware requirements. Requires sufficient credits and calls the VM provisioning service.
- [List Vms](https://docs.lyceum.technology/api-reference/vms/list-vms.md): List VMs for the active org with optional status filtering.
- [Get Vm Availability](https://docs.lyceum.technology/api-reference/vms/get-vm-availability.md): Get hardware profiles from the VM provisioning service which the user is allowed to provision. Availability does not automatically imply that the requested hardware is actually available right now.
- [Get Vm Status](https://docs.lyceum.technology/api-reference/vms/get-vm-status.md): Get detailed status of a specific VM from VM provisioning service.
- [Update Vm](https://docs.lyceum.technology/api-reference/vms/update-vm.md): Update mutable fields on a VM. Currently only ``display_name``.
- [Terminate Vm](https://docs.lyceum.technology/api-reference/vms/terminate-vm.md): Terminate and delete a VM permanently.
- [List Files](https://docs.lyceum.technology/api-reference/storage-files/list-files.md): List files in user's S3 bucket.
- [Upload File](https://docs.lyceum.technology/api-reference/storage-files/upload-file.md): Upload a file to user's S3 bucket.
- [Upload Bulk Files](https://docs.lyceum.technology/api-reference/storage-files/upload-bulk-files.md): Upload multiple files at once, optionally preserving folder structure.
- [Download File](https://docs.lyceum.technology/api-reference/storage-files/download-file.md): Download a file from user's S3 bucket.
- [Delete File](https://docs.lyceum.technology/api-reference/storage-files/delete-file.md): Delete a file from user's S3 bucket.
- [Delete Folder](https://docs.lyceum.technology/api-reference/storage-files/delete-folder.md): Delete all files in a folder (by prefix).
- [Get Storage Credentials](https://docs.lyceum.technology/api-reference/storage-credentials/get-storage-credentials.md): Generate temporary MinIO/S3 storage credentials using STS.
- [Login](https://docs.lyceum.technology/api-reference/authentication/login.md): Login with email and password, return JWT tokens. This JWT can be used directly with MinIO STS.
- [Refresh Token](https://docs.lyceum.technology/api-reference/authentication/refresh-token.md): Refresh an access token using a refresh token.
- [Validate Api Key](https://docs.lyceum.technology/api-reference/api-keys/validate-api-key.md): Validate an API key and return information about it.
- [List API keys](https://docs.lyceum.technology/api-reference/api-keys/list-api-keys.md)
- [Create API key](https://docs.lyceum.technology/api-reference/api-keys/create-api-key.md): Create an org-scoped API key. The plaintext is returned once — never again.
- [Revoke API key](https://docs.lyceum.technology/api-reference/api-keys/revoke-api-key.md)
- [Toggle Api Key](https://docs.lyceum.technology/api-reference/api-keys/toggle-api-key.md): Toggle API key active status.
- [Regenerate API key](https://docs.lyceum.technology/api-reference/api-keys/regenerate-api-key.md): Issue a new secret for an existing key, keeping its name. The plaintext is returned once.
- [List Environment Variables](https://docs.lyceum.technology/api-reference/environment-variables/list-environment-variables.md): List all environment variables for the authenticated user.
- [Upsert Environment Variables](https://docs.lyceum.technology/api-reference/environment-variables/upsert-environment-variables.md): Create or update one or more environment variables.
- [Delete All Environment Variables](https://docs.lyceum.technology/api-reference/environment-variables/delete-all-environment-variables.md): Delete all environment variables for the user.
- [Delete Environment Variable](https://docs.lyceum.technology/api-reference/environment-variables/delete-environment-variable.md): Delete a single environment variable.
- [Get User Status](https://docs.lyceum.technology/api-reference/user-management/get-user-status.md): Check user's authentication status and profile information.
- [Delete User](https://docs.lyceum.technology/api-reference/user-management/delete-user.md): Delete the current authenticated user's account.
- [Get User Quotas](https://docs.lyceum.technology/api-reference/user-quotas/get-user-quotas.md): Get user's machine type quotas and permissions.
- [Get Available Hardware Profiles](https://docs.lyceum.technology/api-reference/user-quotas/get-available-hardware-profiles.md): Get list of hardware profiles available to the user based on their quotas and pricing table.
- [Get User Credits](https://docs.lyceum.technology/api-reference/billing/get-user-credits.md): Get current user's credit balance.
- [Get User Credits Details](https://docs.lyceum.technology/api-reference/billing/get-user-credits-details.md): Get detailed user credits information including Stripe data.
- [Create Signup Grant Setup Intent](https://docs.lyceum.technology/api-reference/billing/create-signup-grant-setup-intent.md): Open a Stripe SetupIntent so the user can verify a card and claim the $20 signup grant.
- [Create Auto Top Up Setup Intent](https://docs.lyceum.technology/api-reference/billing/create-auto-top-up-setup-intent.md): Open a SetupIntent so the org can save a card for off-session auto top-ups.
- [Create Checkout Session](https://docs.lyceum.technology/api-reference/billing/create-checkout-session.md): Create a Stripe checkout session for purchasing credits.
- [Get Execution History](https://docs.lyceum.technology/api-reference/billing/get-execution-history.md): Get execution history for the active org.
- [Get Billing Activities](https://docs.lyceum.technology/api-reference/billing/get-billing-activities.md): Get billing activities for the active org.
- [Get Invoices](https://docs.lyceum.technology/api-reference/billing/get-invoices.md): Get user's credit purchase invoices/receipts.
- [Get balance](https://docs.lyceum.technology/api-reference/billing/get-balance.md): Current billing balance for this org (read from Croesus).
- [Get auto top-up](https://docs.lyceum.technology/api-reference/billing/get-auto-top-up.md): This org's auto top-up configuration (from Croesus); 404 if not configured yet.
- [Set auto top-up](https://docs.lyceum.technology/api-reference/billing/set-auto-top-up.md): Set this org's auto top-up configuration (writes to Croesus). Owner/admin only.
- [Get payment method](https://docs.lyceum.technology/api-reference/billing/get-payment-method.md): The card saved for this org's auto top-up (display info only). has_card is false until a card has been saved via a SetupIntent.
- [List transactions](https://docs.lyceum.technology/api-reference/billing/list-transactions.md): Org's billing-ledger transactions (read from Croesus, newest first).
- [Aggregate transactions](https://docs.lyceum.technology/api-reference/billing/aggregate-transactions.md): Aggregate the org's debits for ``category``, grouped by ``group_by``.
- [Get usage](https://docs.lyceum.technology/api-reference/billing/get-usage.md): Per-user, per-model token usage for an inference ``kind``.
- [List My Orgs](https://docs.lyceum.technology/api-reference/organizations/list-my-orgs.md): List every org the authenticated user belongs to, with their role.
- [Create Org](https://docs.lyceum.technology/api-reference/organizations/create-org.md): Create a new org. The caller becomes its owner.
- [Get Org](https://docs.lyceum.technology/api-reference/organizations/get-org.md)
- [Update Org](https://docs.lyceum.technology/api-reference/organizations/update-org.md): Patch the org's display fields and company billing details. The `id` never changes.
- [Delete Org](https://docs.lyceum.technology/api-reference/organizations/delete-org.md)
- [List Org Members](https://docs.lyceum.technology/api-reference/organizations/list-org-members.md)
- [Add Org Member](https://docs.lyceum.technology/api-reference/organizations/add-org-member.md): Add a user to the org by email.
- [List Org Invites](https://docs.lyceum.technology/api-reference/organizations/list-org-invites.md): List pending invites (not yet accepted) for this org.
- [Revoke Org Invite](https://docs.lyceum.technology/api-reference/organizations/revoke-org-invite.md): Revoke a pending invite. 404 if already accepted or missing.
- [Update Org Member Role](https://docs.lyceum.technology/api-reference/organizations/update-org-member-role.md)
- [Remove Org Member](https://docs.lyceum.technology/api-reference/organizations/remove-org-member.md)
- [List My Pending Invites](https://docs.lyceum.technology/api-reference/org-invites/list-my-pending-invites.md): Pending invites for the caller's email. Tokens not returned — accept via POST /invites/mine/{invite_id}/accept.
- [Accept My Invite](https://docs.lyceum.technology/api-reference/org-invites/accept-my-invite.md): Accept a pending invite by id. Caller's email must match the invite's.
- [Preview Invite](https://docs.lyceum.technology/api-reference/org-invites/preview-invite.md): Public preview of a pending invite for the accept page. No auth — the token itself is the capability.
- [Accept Invite](https://docs.lyceum.technology/api-reference/org-invites/accept-invite.md): Accept an invite and become a member of the org. The caller must be signed in and their email must match the invite's email.
- [Get Pricing](https://docs.lyceum.technology/api-reference/pricing/get-pricing.md): List unit prices from Croesus, optionally filtered to one resource.
- [Get Machine Types](https://docs.lyceum.technology/api-reference/machine-types/get-machine-types.md): Get all machine types with their per-hour price, sourced from Croesus.
- [Get Available Resources](https://docs.lyceum.technology/api-reference/resources/get-available-resources.md): List all available hardware resources including prices.
- [Get User Logs](https://docs.lyceum.technology/api-reference/logs/get-user-logs.md): Get all logs for the current user.
- [Get Execution Logs](https://docs.lyceum.technology/api-reference/logs/get-execution-logs.md): Get all logs for a specific execution.
- [Ping](https://docs.lyceum.technology/api-reference/health/ping.md): Health check endpoint for the Lyceum FastAPI Server.
- [Version](https://docs.lyceum.technology/api-reference/health/version.md): Get FastAPI and system version information.
- [Create Hardware Reminder](https://docs.lyceum.technology/api-reference/infra/create-hardware-reminder.md): Save or update an opt-in to be notified when a hardware profile becomes available.

## OpenAPI Specs

- [openapi](https://docs.lyceum.technology/api-reference/openapi.json)