> ## Documentation Index > Fetch the complete documentation index at: https://docs.ornn.com/llms.txt > Use this file to discover all available pages before exploring further. # Start a staged upload > Reserves an upload of one file and returns a short-lived URL. Send the bytes to upload_url with the returned method and headers, then complete the upload. The session expires after about 15 minutes. Send an Idempotency-Key header to retry safely; a retry with the same key and unchanged input returns the same session, or state complete if it already finished. The file appears in the volume only after completion. Use a staged upload for files larger than 32 MiB. CLI equivalent: `ornn volumes files upload --path --yes --idempotency-key --format json`. ## OpenAPI ````yaml openapi.yaml POST /v1/orchestrator/drives/{drive_id}/uploads openapi: 3.1.0 info: title: Ornn compute API version: 1.0.0 description: >- Customer HTTP API for Ornn GPU capacity. It covers reserved capacity and nodes, VM and Bare Metal access, Kubernetes and Slurm clusters, SSH keys, storage volumes and GitHub repositories, private networks, monitoring, buying and selling capacity (Reserve, Market, Spot, and Relist), and billing. API keys are scoped to one organization and act with their creator's access there; account, team, and API-key management stay in the console. Most operations require an approved organization. See https://docs.ornn.com/api-keys to create a key and https://docs.ornn.com/guides/kubernetes-api for an end-to-end Kubernetes integration. Examples use fictional IDs and credentials. The info.version field identifies the contract revision, not a shared API path version. contact: email: support@ornn.com servers: - url: https://api.ornn.com description: Production security: - OrnnApiKey: [] tags: - name: Authentication - name: Reservations - name: GPU nodes - name: Clusters - name: Workers - name: Virtual machines description: >- Choose a VM disk, launch VM access on a reservation, and read each VM's status, launch progress, and SSH connection details. - name: Bare Metal description: >- Launch Bare Metal access on a reservation, read a host's readiness and SSH connection details, and reboot or hard reset it. - name: SSH keys description: >- Register public keys for your organization, choose which keys a VM or Bare Metal reservation uses, and queue key delivery to machines. Slurm clusters take organization key IDs at launch. Kubernetes API access does not use SSH keys. - name: Reserve description: >- Browse reserved-capacity listings and their terms, and post, cancel, or accept offers. Reserve listings are visible to approved organizations. - name: Market description: >- Browse relisted capacity and buy windows at the asking price, paid up front. Open to every member of your organization. - name: Spot description: >- Hourly order books for VMs with 1, 2, 4, or 8 GPUs on one node: read books, trades, and quotes, place and cancel bids, and follow fills. - name: Relist description: >- Sell whole nodes from a reservation you hold at your asking price, and manage those listings. - name: Storage description: >- Managed volumes, their files, and GitHub repository pulls. Volumes belong to the API key's creator in the key's organization. - name: Networks description: >- Organization private networks and the WireGuard configs you use to reach private machines and clusters. - name: Monitoring description: >- Machine telemetry and console logs for capacity your organization holds. Reads are limited to your reservation window. - name: Billing description: >- Invoices, billing summary, usage cost, Ornn credits, and account statements. Saving a card and paying invoices stay in the console. externalDocs: description: REST integration walkthrough url: >- https://docs.ornn.com/guides/kubernetes-access#provision-and-manage-through-rest paths: /v1/orchestrator/drives/{drive_id}/uploads: parameters: - $ref: '#/components/parameters/PlatformDriveId' post: tags: - Storage summary: Start a staged upload description: >- Reserves an upload of one file and returns a short-lived URL. Send the bytes to upload_url with the returned method and headers, then complete the upload. The session expires after about 15 minutes. Send an Idempotency-Key header to retry safely; a retry with the same key and unchanged input returns the same session, or state complete if it already finished. The file appears in the volume only after completion. operationId: platformStartVolumeUpload parameters: - name: Idempotency-Key in: header required: false description: Caller-chosen key of up to 128 characters, unique per upload. schema: type: string maxLength: 128 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PlatformStartUpload' example: path: datasets/train.parquet size_bytes: 524288000 content_type: application/octet-stream responses: '200': description: The upload session, or state complete for a finished retry. content: application/json: schema: $ref: '#/components/schemas/PlatformUploadSession' example: upload_id: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb path: datasets/train.parquet method: PUT upload_url: https://storage.example.com/upload/bbbbbbbb?signature=example headers: Content-Type: application/octet-stream expires_in_seconds: 900 max_size_bytes: 10737418240 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/PlatformVolumeNotFound' '409': description: >- The idempotency key was used for different input, the session expired, or the volume is busy. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: storage_upload_idempotency_conflict message: >- This upload key was already used for different input. Use a new key for a different upload. '413': description: The declared size exceeds the upload limit. content: application/json: schema: $ref: '#/components/schemas/Error' default: $ref: '#/components/responses/Error' components: parameters: PlatformDriveId: name: drive_id in: path required: true description: Volume ID. schema: type: string format: uuid example: 77777777-7777-4777-8777-777777777777 schemas: PlatformStartUpload: type: object required: - path - size_bytes properties: path: type: string description: Destination path relative to the volume root. size_bytes: type: integer format: int64 minimum: 0 description: Exact size of the file you will upload. content_type: type: string default: application/octet-stream sha256: type: string description: >- Optional lowercase or uppercase hex SHA-256 of the file, 64 characters. PlatformUploadSession: type: object properties: upload_id: type: string format: uuid path: type: string method: type: string description: HTTP method for upload_url, currently PUT. upload_url: type: string description: >- Short-lived URL that accepts the file bytes. Do not send your Ornn API key to it. headers: type: object additionalProperties: type: string description: Headers to send with the upload. expires_in_seconds: type: integer max_size_bytes: type: integer format: int64 state: type: string description: complete when a retried key already finished. Error: type: object properties: code: type: string detail: oneOf: - type: string - type: object required: - code - message properties: code: type: string message: type: string responses: Unauthorized: description: >- The credential is missing, invalid, revoked, or no longer belongs to a current organization member. Check the HTTP status before parsing the body. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: >- The credential lacks access to this operation, or the organization requires approval. An API key does not bypass these checks. content: application/json: schema: $ref: '#/components/schemas/Error' PlatformVolumeNotFound: description: The volume does not exist or is not one of your volumes. content: application/json: schema: $ref: '#/components/schemas/Error' example: detail: code: storage_drive_not_found message: Ornn could not find that volume. Error: description: >- Unsuccessful request. Check HTTP status first. Errors may have detail.code/detail.message, a string detail and optional top-level code, or an empty/non-JSON body. 401: invalid credential; 403: access or approval required; 404: not visible or credentials not ready; 409: lifecycle conflict; 429: back off; 5xx: service failure. Inspect current state before retrying mutations. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: OrnnApiKey: type: http scheme: bearer bearerFormat: ornn_sk_... description: >- Create an organization API key in Account Settings > Developer. Do not send this key to the Kubernetes API server. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.