> ## 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.

# Place a bid

> Bids for GPUs or for nodes; send exactly one of gpus or nodes. A bid takes capacity from the lowest asks at or below your limit, fees included, oldest first at each price, across listings and, without a region, across locations. With gpus it takes GPUs until it has enough, so one node can supply part of a bid and a bid can span nodes. With nodes it takes that many distinct nodes with a GPU free, and every GPU free on each; each node runs as one VM, or as a few VMs on hosts whose GPUs can only be split in powers of two (6 GPUs run as a 4-GPU and a 2-GPU VM). A limit bid rests whatever it did not take, and later capacity fills it further; a market bid takes what is for sale now and cancels the rest with cancelReason unfilled_market_order. A bid never takes your own organization's capacity.

nodes needs a market order; a limit bid with nodes is refused with nodes_need_market_order. The order counts GPUs: a bid for nodes records the GPUs it took as requested, and is filled when it found every node.

Each set of GPUs the bid buys from one listing is a fill: one reservation whose ID is the fill ID, listed in the order's fillIds. The reservation appears shortly after the fill; poll GET /commerce/reservations/{reservationId} using the fill ID. Each hour is prepaid when it starts, from Ornn credits first and then your saved card. The bid is not refused for a missing card, but if the first or a later hour cannot be paid the reservation ends with endReason payment_failed. Save a card in the console before bidding unless your credits cover the hours.

Requires Idempotency-Key. Available to every member of your organization; approval is not required.

CLI equivalent, a market bid for nodes: `ornn market bid --gpu-slug <gpu-slug> --nodes 2 --yes`. Pass `--idempotency-key` to make a retry safe.

Send a new `Idempotency-Key` for each bid. If the response is lost, retry with the same key and body: you get the original order back instead of a second bid. See [Rent GPUs on Spot](/guides/pay-as-you-go.md#use-the-api).


## OpenAPI

````yaml openapi.yaml POST /v1/markets/orders
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, order books, 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: Order books
    description: >-
      Hourly order books for whole nodes, one VM per node: read books, trades,
      and quotes, place and cancel bids, and follow and end 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/markets/orders:
    post:
      tags:
        - Order books
      summary: Place a bid
      description: >-
        Bids for GPUs or for nodes; send exactly one of gpus or nodes. A bid
        takes capacity from the lowest asks at or below your limit, fees
        included, oldest first at each price, across listings and, without a
        region, across locations. With gpus it takes GPUs until it has enough,
        so one node can supply part of a bid and a bid can span nodes. With
        nodes it takes that many distinct nodes with a GPU free, and every GPU
        free on each; each node runs as one VM, or as a few VMs on hosts whose
        GPUs can only be split in powers of two (6 GPUs run as a 4-GPU and a
        2-GPU VM). A limit bid rests whatever it did not take, and later
        capacity fills it further; a market bid takes what is for sale now and
        cancels the rest with cancelReason unfilled_market_order. A bid never
        takes your own organization's capacity.


        nodes needs a market order; a limit bid with nodes is refused with
        nodes_need_market_order. The order counts GPUs: a bid for nodes records
        the GPUs it took as requested, and is filled when it found every node.


        Each set of GPUs the bid buys from one listing is a fill: one
        reservation whose ID is the fill ID, listed in the order's fillIds. The
        reservation appears shortly after the fill; poll GET
        /commerce/reservations/{reservationId} using the fill ID. Each hour is
        prepaid when it starts, from Ornn credits first and then your saved
        card. The bid is not refused for a missing card, but if the first or a
        later hour cannot be paid the reservation ends with endReason
        payment_failed. Save a card in the console before bidding unless your
        credits cover the hours.


        Requires Idempotency-Key. Available to every member of your
        organization; approval is not required.
      operationId: capacityPlaceBid
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Required. A unique key of 1 to 200 characters for this operation,
            such as a UUID. Retrying with the same key and the same body returns
            the original result with HTTP 200 instead of creating a second one.
            The key is remembered for 24 hours per organization; reusing it for
            a different request returns 409 idempotency_conflict. A missing key
            returns 400 idempotency_key_required.
          schema:
            type: string
            minLength: 1
            maxLength: 200
          example: 3f1c2a9e-6b1d-4c55-9a77-0d2b8f1e4c10
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CapacityMarketBidRequest'
            example:
              gpuSlug: nvidia_h100_sxm
              nodes: 2
              orderType: market
      responses:
        '200':
          description: >-
            A retry with the same Idempotency-Key and body; returns the original
            order's current state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityMarketOrderEnvelope'
              example:
                order:
                  orderId: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
                  orderBookId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb
                  gpuSlug: nvidia_h100_sxm
                  saleType: spot
                  region: null
                  side: bid
                  orderType: limit
                  pricePerGpuHourMicroUsd: 2500000
                  requested: 16
                  remaining: 16
                  filledNodes: 0
                  filledGpus: 0
                  fillIds: []
                  status: resting
                  cancelReason: null
                  createdAt: '2026-10-14T18:30:00.000Z'
                  isMine: true
                  isSeller: false
        '201':
          description: >-
            Bid placed. Check order.status: filled (everything requested
            bought), resting (waiting for more), or cancelled (a market bid's
            rest found nothing); fillIds lists what it bought.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CapacityMarketOrderEnvelope'
              example:
                order:
                  orderId: aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa
                  orderBookId: bbbbbbbb-bbbb-4bbb-8bbb-bbbbbbbbbbbb
                  gpuSlug: nvidia_h100_sxm
                  saleType: spot
                  region: null
                  side: bid
                  orderType: market
                  pricePerGpuHourMicroUsd: null
                  requested: 16
                  remaining: 0
                  filledNodes: 2
                  filledGpus: 16
                  fillIds:
                    - dddddddd-dddd-4ddd-8ddd-dddddddddddd
                  status: filled
                  cancelReason: null
                  createdAt: '2026-10-14T18:30:00.000Z'
                  isMine: true
                  isSeller: false
        '400':
          description: Missing Idempotency-Key or invalid body.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: idempotency_key_required
                  message: Send an Idempotency-Key header with this request.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: There is no order book for that GPU slug.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: order_book_not_found
                  message: There is no order book for that GPU type.
        '409':
          description: The Idempotency-Key was already used for a different request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: idempotency_conflict
                  message: That request key was already used for a different request.
        '422':
          description: >-
            Both gpus and nodes were sent (quantity_conflict), neither was or it
            is not a positive whole number (invalid_quantity), nodes was sent
            with a limit (nodes_need_market_order), orderType or saleType is
            unknown (invalid_sale_type), the region has no order book
            (unknown_region), or a limit has no positive price.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                detail:
                  code: nodes_need_market_order
                  message: >-
                    Buy nodes with a market order. A limit bid takes a number of
                    GPUs.
        default:
          $ref: '#/components/responses/Error'
components:
  schemas:
    CapacityMarketBidRequest:
      type: object
      description: Send exactly one of gpus or nodes; nodes needs orderType market.
      required:
        - gpuSlug
        - orderType
      additionalProperties: false
      properties:
        gpuSlug:
          type: string
          description: Catalog GPU slug of the order book.
        saleType:
          type: string
          enum:
            - spot
            - on-demand
          default: spot
          description: >-
            spot: a reservation on the node can end the VM. on-demand: only a
            stop or the listing's end ends it.
        region:
          type: string
          description: >-
            A region with an order book, for example us-east-11 (see GET
            /v1/markets/books). Omit to fill at any location. A region without a
            book is refused with unknown_region.
        gpus:
          type: integer
          minimum: 1
          description: >-
            GPUs, taken from the lowest asks first; one node can supply part of
            them and a bid can span nodes. Send this or nodes.
        nodes:
          type: integer
          minimum: 1
          description: >-
            Distinct nodes with a GPU free, each giving every GPU free on it.
            Market orders only (nodes_need_market_order on a limit). Send this
            or gpus.
        orderType:
          type: string
          enum:
            - limit
            - market
          description: >-
            limit takes capacity at or below your price and rests the rest until
            it fills or you cancel. market takes what is for sale now and
            cancels the rest.
        pricePerGpuHourMicroUsd:
          type: integer
          format: int64
          minimum: 1
          description: >-
            Required for limit bids; omit for market bids. The most you pay per
            GPU-hour, fees included, in integer micro-USD (1000000 is $1.00).
        diskId:
          type: string
          format: uuid
          description: >-
            The disk every VM boots, from your disks or Ornn's. Omit to boot
            your newest disk, else Ornn's newest.
    CapacityMarketOrderEnvelope:
      type: object
      required:
        - order
      properties:
        order:
          $ref: '#/components/schemas/CapacityMarketOrder'
    Error:
      type: object
      properties:
        code:
          type: string
        detail:
          oneOf:
            - type: string
            - type: object
              required:
                - code
                - message
              properties:
                code:
                  type: string
                message:
                  type: string
    CapacityMarketOrder:
      type: object
      required:
        - orderId
        - side
        - status
        - isMine
        - isSeller
      properties:
        orderId:
          type: string
          format: uuid
          description: Order ID.
        orderBookId:
          type: string
          format: uuid
        gpuSlug:
          type:
            - string
            - 'null'
        saleType:
          type:
            - string
            - 'null'
          enum:
            - spot
            - on-demand
            - null
        region:
          type:
            - string
            - 'null'
          description: >-
            The order's region slug; null for a bid at any location. Each fill
            says where it runs.
        side:
          type: string
          enum:
            - bid
            - ask
          description: bid for your bids; ask for capacity your listings offer on the book.
        orderType:
          type: string
          enum:
            - limit
            - market
        pricePerGpuHourMicroUsd:
          type:
            - integer
            - 'null'
          format: int64
          description: >-
            The order's own price: a bid's limit, or null for a market bid. Each
            fill's price is on the fill and its reservation.
        requested:
          type:
            - integer
            - 'null'
          description: >-
            The GPUs a bid asked for; for a bid for nodes, the GPUs it took.
            Null for an ask.
        remaining:
          type:
            - integer
            - 'null'
          description: The GPUs a bid has not bought yet.
        filledNodes:
          type:
            - integer
            - 'null'
          description: The nodes a bid has bought on, across its fills.
        filledGpus:
          type:
            - integer
            - 'null'
          description: The GPUs a bid has bought, across its fills.
        gpus:
          type:
            - integer
            - 'null'
          description: The GPUs an ask has for sale now; null for a bid.
        fillIds:
          type: array
          items:
            type: string
            format: uuid
          description: A bid's fills, oldest first; each is also a reservation ID.
        nodeGpus:
          type:
            - integer
            - 'null'
          description: The GPUs an ask's node has; null for a bid.
        status:
          type: string
          description: >-
            Bids: resting (waiting for more), filled (everything requested
            bought), or cancelled (the rest withdrawn; its fills keep running).
            Asks: resting, exhausted (every GPU on its node sold), or cancelled.
            Handle unrecognized values.
        cancelReason:
          type:
            - string
            - 'null'
          description: >-
            For example unfilled_market_order, cancelled_by_owner, or
            cancelled_by_admin.
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
        isMine:
          type: boolean
          description: True when your organization placed this order.
        isSeller:
          type: boolean
          description: True when the order is capacity your organization listed.
  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'
    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.