Skip to content
HIPS
  • Earn with your GPU
  • Pricing
  • Docs
Sign inJoin early access
⌘K

Get started

  1. 01Developer hub
  2. 02Quickstart
  3. 03Migrate to HIPS

Guides

  1. 04HIPS SDK
    1. APython
    2. BTypeScript and JavaScript
    3. CGo
    4. DRust
    5. EJava
    6. F.NET
    7. GPHP
    8. HRuby
  2. 05Import and run your model
  3. 06Model and task guides
    1. ATask guides
    2. BLanguage (chat)
    3. CClassification
    4. DImage
    5. EVideo
    6. FAudio
    7. GDocument processing
  4. 07Batch jobs
  5. 08Prompt caching
  6. 09Coding-tool setup
    1. AClaude Code
    2. BOther coding tools and editor integrations
  7. 10Command line
    1. ASign in

Reference

  1. 11API reference
    1. AAuthentication
    2. BChat completions
    3. CResponses
    4. DModels
    5. ETasks
    6. FJobs
    7. GUploads
    8. HDeployments
    9. IRequirements and headers
    10. JErrors
    11. KUsage
    12. LVersioning
  2. 12Operating guidance
    1. ALimits
    2. BErrors
    3. CRetries and billing outcomes
    4. DIdempotency
    5. EStreaming
    6. FData handling
    7. GCompatibility matrix
  3. 13Changelog
Sheet indexAPI reference

Get started

  1. 01Developer hub
  2. 02Quickstart
  3. 03Migrate to HIPS

Guides

  1. 04HIPS SDK
    1. APython
    2. BTypeScript and JavaScript
    3. CGo
    4. DRust
    5. EJava
    6. F.NET
    7. GPHP
    8. HRuby
  2. 05Import and run your model
  3. 06Model and task guides
    1. ATask guides
    2. BLanguage (chat)
    3. CClassification
    4. DImage
    5. EVideo
    6. FAudio
    7. GDocument processing
  4. 07Batch jobs
  5. 08Prompt caching
  6. 09Coding-tool setup
    1. AClaude Code
    2. BOther coding tools and editor integrations
  7. 10Command line
    1. ASign in

Reference

  1. 11API reference
    1. AAuthentication
    2. BChat completions
    3. CResponses
    4. DModels
    5. ETasks
    6. FJobs
    7. GUploads
    8. HDeployments
    9. IRequirements and headers
    10. JErrors
    11. KUsage
    12. LVersioning
  2. 12Operating guidance
    1. ALimits
    2. BErrors
    3. CRetries and billing outcomes
    4. DIdempotency
    5. EStreaming
    6. FData handling
    7. GCompatibility matrix
  3. 13Changelog
11
  1. Docs/
  2. API reference/
  3. Requirements and headers
(Detail I)

PreviewNot yet validated. Join early access

llms.txt

Requirements and headers

On this sheet4 sections
  1. Request requirements
  2. The hips body object
  3. Response headers
  4. Request id

Pool, pricing mode, region and fallback are requirements of a request. The scheduler enforces them on every attempt; the gateway validates them and binds the quote under them.

F
Fig. 1, sheet 11API reference

Request requirements

RequirementHeader (OpenAI-compatible routes)`hips` body field (task API)ValuesDefault when the key has none
Poolx-hips-poolpoolpersonal, approvedSet on the key at creation Not decided yet
Pricing modex-hips-pricing-modepricing_modemarket, stablemarket
Regionx-hips-regionregionA coarse code Not decided yet, or absentAbsent (no region constraint)
Fallbackx-hips-fallbackfallbacktrue, falsefalse
  • Requirement
    Pool
    Header (OpenAI-compatible routes)
    x-hips-pool
    `hips` body field (task API)
    pool
    Values
    personal, approved
    Default when the key has none
    Set on the key at creation Not decided yet
  • Requirement
    Pricing mode
    Header (OpenAI-compatible routes)
    x-hips-pricing-mode
    `hips` body field (task API)
    pricing_mode
    Values
    market, stable
    Default when the key has none
    market
  • Requirement
    Region
    Header (OpenAI-compatible routes)
    x-hips-region
    `hips` body field (task API)
    region
    Values
    A coarse code Not decided yet, or absent
    Default when the key has none
    Absent (no region constraint)
  • Requirement
    Fallback
    Header (OpenAI-compatible routes)
    x-hips-fallback
    `hips` body field (task API)
    fallback
    Values
    true, false
    Default when the key has none
    false
  • Precedence: a value in the request (header or hips field) beats the key's default; the key's default beats the platform default. On the task API both may be sent; when both are present and differ, a 400 requirement_conflict. The HIPS SDK sends the hips object and never the headers.
  • Validation at the gateway: an unknown value is a 400 invalid_requirement. A region on a plan without region selection is a 403 region_not_on_plan. stable without a stable price in force is a 400 stable_price_not_in_force. A conflict the catalog decides statically is a 400 requirement_conflict.
  • Enforcement at the scheduler: whether eligible supply exists now is not the gateway's to know for certain; pool_unavailable and no_capacity are 503s from the scheduler's answer. Never silently cross a required boundary to make a request succeed.
  • Fallback never weakens a rule: fallback: true lets the scheduler place a job in the other pool when the named pool has nothing eligible; it never relaxes region or the request-data policy, and it is off by default.
  • Requirements travel with the job: stored at acceptance, applied to every attempt and every retry; the requirements object on a job and the x-hips-pool, x-hips-pricing-mode and x-hips-region response headers show the effective ones.
  • The lane is not a requirement: a dep_ on an allocation is always_on; everything else is shared. x-hips-lane reports it.

On the OpenAI clients a requirement rides as a header: default_headers on the Python client, defaultHeaders on the Node client, -H on cURL.

The hips body object

hips

00000000000000000000000000000000000000001{"hips": {"pool": "personal", "pricing_mode": "market", "region": null, "fallback": false}}
hips sample

Response headers

On every response, errors included unless the rule says otherwise. The x-hips-* values are also what the usage record stores, so a client that logs the headers can reconcile against the Console line by line.

  1. 01
    x-hips-request-idreq_...

    On every response, every error, every stream head and every idempotent replay (the original's).

  2. 02
    x-hips-modelpinned id

    The pinned id served. Not on errors before resolution.

  3. 03
    x-hips-deploymentdep_...

    The deployment id, when the request named one.

  4. 04
    x-hips-poolpersonal or approved

    The pool that ran the work. When fallback was used, this is how a client sees it. Not on errors before placement.

  5. 05
    x-hips-laneshared or always_on

    Follows from what the request names: a dep_ on an allocation is always_on; everything else is shared.

  6. 06
    x-hips-pricing-modemarket or stable

    The effective pricing mode.

  7. 07
    x-hips-regionregion code

    The effective region code, or absent.

  8. 08
    x-hips-quotequote_... or offer_...

    The quote bound at acceptance; on a stable request, the stable-price offer in force. Whether it also carries the bound rates is open Not decided yet.

  9. 09
    x-hips-cost-microsinteger

    The charge in USD micro-dollars. Not on streamed responses (the hips object of the final usage chunk instead) and not on errors (nothing charged).

  10. 10
    x-hips-latency-msinteger

    From the gateway's receipt of the complete request to the complete answer. On a streamed response, in the hips object.

  11. 11
    x-ratelimit-limit-requests, x-ratelimit-remaining-requests, x-ratelimit-reset-requestsinteger, integer, duration

    The key's request limit in the current window, what remains, and the time to reset in OpenAI's duration format, so clients that read them keep working.

  12. 12
    x-ratelimit-limit-tokens, x-ratelimit-remaining-tokens, x-ratelimit-reset-tokensinteger, integer, duration

    The same for tokens on language-model routes; on the task API the unit is task units with the same header names.

  13. 13
    Retry-Afterseconds

    On 429 and 503, nothing else.

Request id

x-hips-request-id: req_<base32> is on every response, every error, every stream head and every idempotent replay (the original's). It is the id of a chat completion, it is carried to the worker and onto every attempt, it is the usage record's key, and the Console's Usage and activity view searches by it. A support question quotes it. HIPS does not accept a client-chosen request id; whether the gateway also sends x-request-id is open Not decided yet.

Related sheets

  • Limits
  • Data handling
Previous sheetDeployments
Next sheetErrors
Sheet
11 of 13
Detail
I
Updated
2026-10-21
Status
Preview
Join early access

On this sheet

  1. Request requirements
  2. The hips body object
  3. Response headers
  4. Request id

Product

  • Inference
  • Models
  • Deploy your model
  • Always-on GPU capacity
  • How it works
  • Use cases
  • Pricing

Developer

  • Docs
  • Quickstart preview
  • Migrate to HIPS
  • HIPS SDK
  • Batch jobs
  • API reference

Provider

  • Earn with your GPU
  • Register GPU interest
  • Download for Mac
  • Download for Windows
  • Download for Linux

Resource

  • Security and Data
  • Resources
  • llms.txt

Company

  • About
  • Contact
  • Affiliate program
  • HIPS Payments

Legal

  • Legal
  • Consumer Health Data Privacy Policy
  • Report content
  • Cookie settings

Support

  • Contact HIPS
  • Looking for payments support?

HIPS. AI inference for builders.

hips.com

Hyperscale Inference Processing Systems OÜ