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
  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. 09Code with HIPS
  7. 10Coding-tool setup
    1. AHIPS Code
    2. BClaude Code
    3. CCodex
    4. DOpenCode
    5. EKilo
    6. FPi
    7. GQwen Code
    8. HCrush
    9. ICline
    10. JPrime Agent
    11. KAider
    12. LGoose
    13. MHermes Agent
    14. NGrok Build
    15. ODeepSeek Harness
    16. POther coding tools and editor integrations
  8. 11Command line
    1. AInstall and update
    2. BSign in
    3. CStatus and models
    4. DCoding agents
  9. 12Console
    1. AAccount
    2. BWorkspaces
    3. CAPI keys
    4. DSettings
    5. EUsage
    6. FModels
    7. GPlayground
    8. HDeployments
  10. 13Billing
  11. 14Provider setup
    1. AWhen it works
    2. BCommands
    3. CSettings
    4. DProvider Console
    5. EEarnings
    6. FCrash reports
    7. GData centers
  12. 15Semantic routing
  13. 16Guardrails
  14. 17Knowledge

Reference

  1. 18API reference
    1. AAuthentication
    2. BChat completions
    3. CResponses
    4. DMessages
    5. ECount tokens
    6. FModels
    7. GPrices API
    8. HTasks
    9. IEmbeddings and rerank
    10. JImages
    11. KJobs
    12. LUploads
    13. MFiles
    14. NBatches
    15. OWebhooks
    16. PVector stores
    17. QDeployments
    18. RRequirements and headers
    19. SErrors
    20. TUsage
    21. UVersioning
  2. 19Operating guidance
    1. ALimits
    2. BErrors
    3. CRetries and billing outcomes
    4. DIdempotency
    5. EStreaming
    6. FData handling
    7. GCompatibility matrix
  3. 20Changelog
Sheet indexAPI reference

Get started

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

Guides

  1. 04HIPS SDK
  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. 09Code with HIPS
  7. 10Coding-tool setup
    1. AHIPS Code
    2. BClaude Code
    3. CCodex
    4. DOpenCode
    5. EKilo
    6. FPi
    7. GQwen Code
    8. HCrush
    9. ICline
    10. JPrime Agent
    11. KAider
    12. LGoose
    13. MHermes Agent
    14. NGrok Build
    15. ODeepSeek Harness
    16. POther coding tools and editor integrations
  8. 11Command line
    1. AInstall and update
    2. BSign in
    3. CStatus and models
    4. DCoding agents
  9. 12Console
    1. AAccount
    2. BWorkspaces
    3. CAPI keys
    4. DSettings
    5. EUsage
    6. FModels
    7. GPlayground
    8. HDeployments
  10. 13Billing
  11. 14Provider setup
    1. AWhen it works
    2. BCommands
    3. CSettings
    4. DProvider Console
    5. EEarnings
    6. FCrash reports
    7. GData centers
  12. 15Semantic routing
  13. 16Guardrails
  14. 17Knowledge

Reference

  1. 18API reference
    1. AAuthentication
    2. BChat completions
    3. CResponses
    4. DMessages
    5. ECount tokens
    6. FModels
    7. GPrices API
    8. HTasks
    9. IEmbeddings and rerank
    10. JImages
    11. KJobs
    12. LUploads
    13. MFiles
    14. NBatches
    15. OWebhooks
    16. PVector stores
    17. QDeployments
    18. RRequirements and headers
    19. SErrors
    20. TUsage
    21. UVersioning
  2. 19Operating guidance
    1. ALimits
    2. BErrors
    3. CRetries and billing outcomes
    4. DIdempotency
    5. EStreaming
    6. FData handling
    7. GCompatibility matrix
  3. 20Changelog
18
  1. Docs/
  2. API reference/
  3. Requirements and headers
(Detail R)
llms.txt

Requirements and headers

On this sheet6 sections
  1. Request requirements
  2. Answers in the Certified pool
  3. The hips body object
  4. Request headers
  5. Response headers
  6. 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 18API reference

Request requirements

RequirementHeader (OpenAI-compatible routes)`hips` body field (task API)ValuesDefault when the key has none
Poolx-hips-poolpoolauto, community, certified (the former personal and approved are still taken, the same pools)auto: the platform's default, and a key's unless it names a pool
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
    auto, community, certified (the former personal and approved are still taken, the same pools)
    Default when the key has none
    auto: the platform's default, and a key's unless it names a pool
  • 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.
  • Auto: a request whose pool is auto, named or by default, runs in one pool the scheduler chooses for it at acceptance, among the pools the workspace allows that offer and price the model and have eligible supply for it now under every other requirement. It takes the lowest balanced score of the request's expected charge in the pool and the expected time to first token there, ties to the lower price and then to the Certified pool; where a pool has no estimate of the first token, price alone decides. The pool chosen serves every attempt and retry of the job and prices it: x-hips-pool and x-hips-quote name that pool and its quote.
  • 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 a region requirement, and it is off by default. Under auto it changes nothing: Auto already takes any pool the request may use.
  • A pool in the model id: on chat completions, Responses and Messages, model may end in :auto, :certified or :community, which is x-hips-pool naming that pool, with fallback off for a pool; x-hips-pool naming anything else beside it, or x-hips-fallback: true beside a pool, is a 400 requirement_conflict (A pool in the model id).
  • 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.

Answers in the Certified pool

  • HIPS serves every request in the Certified pool, at the Certified pool's rates for the model, the quote x-hips-quote names.
  • Its answer's x-hips-pool reads certified, and x-hips-model and the answer's model name the model served. The x-hips-gpu-* headers are sent only where they are known, so an answer in the Certified pool may carry none.
  • A parameter a model does not take is never stripped: the request is answered 400 unsupported_parameter, its param naming it (Request parameters).

The hips body object

hips

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

Request headers

Besides Authorization: Bearer and the requirements above:

  1. 01
    x-hips-pool, x-hips-pricing-mode, x-hips-region, x-hips-fallbackthe requirements

    The four request requirements on the OpenAI-compatible routes and on Messages, below.

  2. 02
    idempotency-keystring

    On POST /v1/tasks, POST /v1/embeddings, POST /v1/rerank, POST /v1/images/generations, POST /v1/images/edits, and on uploads, files and batches where they are offered (Idempotency). Never on chat completions, Responses or Messages.

  3. 03
    x-api-keya key or a person's token

    On POST /v1/messages alone, as Anthropic's clients send it: the same credential as Authorization: Bearer. Both sent with different values is a 401 invalid_api_key.

  4. 04
    anthropic-version2023-06-01

    Required on POST /v1/messages: absent is a 400 missing_required_parameter, another value a 400 invalid_value.

  5. 05
    anthropic-betastring

    On POST /v1/messages, read as information and never refused: the body's fields decide what is asked for.

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). A fresh id per request: the gateway never takes a client's.

  2. 02
    x-request-idreq_...

    The same id under the generic name the OpenAI SDKs read (their _request_id), on every response of the gateway.

  3. 03
    x-hips-modelpinned id

    The pinned id served; under a router, the model the router chose, never the router. Not on errors before resolution.

  4. 04
    x-hips-deploymentdep_...

    The deployment id, when the request named one.

  5. 05
    x-hips-poolcommunity or certified

    The pool that ran the work, never auto: under auto the pool the scheduler chose. When fallback was used, or the request ran under auto, this is how a client sees it. Not on errors before placement.

  6. 06
    x-hips-laneshared or always_on

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

  7. 07
    x-hips-pricing-modemarket or stable

    The effective pricing mode.

  8. 08
    x-hips-regionregion code

    The effective region code, or absent.

  9. 09
    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.

  10. 10
    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).

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

  12. 12
    x-hips-gpu-model, x-hips-gpu-vendor, x-hips-gpu-backendstrings

    On an answer a provider's GPU served (H132, decided 2026-11-09): the model of that GPU as its machine reported it, in its normal form; the vendor; and the backend its engine ran on. Each is sent where it is known; x-hips-gpu-model is left out while too few providers report that model. Never an id of the device, the GPU or the provider. Absent where the server that answered is no provider's GPU, so an answer in the Certified pool may carry none (Answers in the Certified pool).

  13. 13
    x-hips-router<router>; preference=<value>; ...

    On an answer a router chose the model for: the router's name, then ; -separated members, preference, source and read always, reason, task, difficulty, floor and tries where they apply. The answer's hips.router object carries the same.

  14. 14
    x-hips-guardrailsgrd_...;<action>, comma-separated

    On an answer a content moderation guardrail acted on with flag or redact: each guardrail's id and its action, ;unavailable after one whose check could not run. Never a matched value.

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

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

    The same for tokens on the language-model routes.

  17. 17
    x-ratelimit-limit-uploads, x-ratelimit-remaining-uploads, x-ratelimit-reset-uploadsinteger, integer, seconds

    On POST /v1/uploads and its 429, under the workspace's daily cap on uploads: the cap, what remains, and the seconds until the oldest upload of the window leaves it (86394s).

  18. 18
    idempotent-replayedtrue

    On an answer replayed for an idempotency-key (uploads, files, batches), with the original's x-hips-request-id.

  19. 19
    x-should-retryfalse

    On a 500 deadline_exceeded: the request's own time bound ended it, so an SDK does not send it again unchanged.

  20. 20
    Server-Timingkb-base, kb-embed, kb-search

    On a Knowledge search, the time of each stage. Knowledge is not switched on in production yet.

  21. 21
    openai-poll-after-msinteger

    On a Knowledge base or document still being read: when to read it again, as OpenAI's SDKs poll. Knowledge is not switched on in production yet.

  22. 22
    Allowmethods

    On a 404 method_not_allowed: the methods the path takes (POST, or GET, HEAD, DELETE).

  23. 23
    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), and the same id is sent as x-request-id, the name the OpenAI SDKs read. It is the id of a chat completion and of a Responses and Messages answer, 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: an id a client sends under either name is ignored and a fresh one is made.

Related sheets

  • Limits
  • Data handling
Previous sheetDeployments
Next sheetErrors
Sheet
18 of 20
Detail
R
Updated
2026-11-16
Sign in to the Console

On this sheet

  1. Request requirements
  2. Answers in the Certified pool
  3. The hips body object
  4. Request headers
  5. Response headers
  6. Request id

Product

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

Developer

  • Docs
  • Quickstart
  • 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

Compare

  • OpenRouter alternatives
  • Together AI alternatives
  • Groq alternatives
  • All comparisons

Company

  • About
  • Contact
  • Affiliate program
  • HIPS Payments

Legal

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

Support

  • Contact HIPS
  • Looking for payments support?

HIPS. AI inference for builders.

hips.com

Hyperscale Inference Processing Systems OÜ