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. Models
(Detail F)
llms.txt

Models

On this sheet2 sections
  1. The hips object on each entry
  2. Errors these routes can answer

OpenAI's list shape: the four routers first, then one entry per published catalog model under its id and one under its pinned id. Each entry has OpenAI's id, object: "model", created (the model's release, else the catalog's publication) and owned_by: "hips", then hugging_face_id, the Hugging Face repository the model was added from (null on a router), and the hips object.

GET/v1/modelsserved

The routers, models and deployments the key may name, with the hips extensions.

GET/v1/models/{id}served

One entry of the list, by catalog id, pinned id, router name or dep_ id.

F
Fig. 1, sheet 18API reference

The hips object on each entry

  1. 01
    task

    The task type: chat for a language model, else the model's own (classification, embedding, rerank, and the others of the task API).

  2. 02
    modality

    On a language model, {"input": ["text"] or ["text", "image"], "output": ["text"]}; null on any other.

  3. 03
    family, version, aliases, pinned_ids

    The catalog entry's names; pinned_ids the version served now.

  4. 04
    status

    The model's catalog status, as published.

  5. 05
    billing_unit

    The unit the model is billed in, as the catalog sets it.

  6. 06
    features

    The features the model advertises, per pool: {"certified": [...], "community": [...]}.

  7. 07
    tool_calls

    On a language model, the state of its tool calls per pool and at their best: validated (tested and passed), template (its chat template takes tools, not tested yet) or none. Hosted tools need validated in the pool the request resolves to. null on any other model.

  8. 08
    pools

    The supply state per pool under no requirements: available, limited, unavailable or unknown. A snapshot, never a reservation; stale becomes unknown.

  9. 09
    availability

    What each pool can do for your key now, in its pools and region: {"certified": {"state", "reason", "as_of", "context_window"}, "community": {...}}, state serving (a slot is free now with the model loaded: a request is served at once), on_demand (no slot is free with it loaded, but a GPU free with it on disk loads it when asked, which can take minutes or longer, or every GPU that offers it is busy: a request waits), none (a request will not succeed now) with its reason (not_offered, excluded, no_supply) or unknown (stale, not_read, or intermittent: a GPU offered it within the last five minutes and none does at this reading, so a request may yet succeed), never serving from a stale reading. context_window is the longest prompt the pool serves now, in tokens, null where it serves none, beside the model's own context_length.

  10. 10
    coding_agents

    On a language model, the coding agents it works with: {"state", "agents": {"hips_code" | "opencode" | "claude_code" | "codex": {"state", "reason"}}}, state tested, requirements (meets them, not tested yet), failed or none. GET /v1/models/{id} adds each agent's tests. Each agent's name and route are said once, in the list's top-level hips.coding_agents.

  11. 11
    lanes

    shared, always_on or both.

  12. 12
    pricing_modes

    The pricing modes the model is sold in: market, and stable where a stable price is offered.

  13. 13
    context_length, max_output_tokens, limits

    The model's limits; limits holds the task-specific ones (inputs per request, input bytes, an embedding model's dimensions and truncatable).

  14. 14
    license

    The model's license identifier and conditions URL.

  15. 15
    deprecates_at

    For a pinned id with a retirement date; null otherwise.

  16. 16
    hugging_face_revision

    On a pinned id's entry alone: the commit of the Hugging Face repository the version was made from.

  17. 17
    allowed, allowed_by

    Only on an entry an access guardrail keeps out of this key's reach: allowed: false and allowed_by: {"guardrail": "grd_...", "name"}; or on a model or a router the workspace's plan does not include: allowed: false and allowed_by: {"plan": "free", "required_plan": "pro"}, the workspace's plan and the lowest plan that includes it, the plan's mark alone where both apply. Absent on every entry the key may name.

  18. 18
    router

    Only on a router's entry: {"use_case", "type", "tasks", "preference", "suffixes": ["fast", "cheap"], "candidates", "ready"}: type one of text, image, audio or video (text for the four), tasks the tasks it routes (["chat"] for the four), the models it can choose for this key now and how many of them are ready (Semantic routing).

The list's own top-level hips member carries defaults, the requirements a request of this key carries when it names none (pool, pricing_mode, region, fallback, pools); pool is null for Auto, which requires no pool and chooses one per request. It also carries coding_agents, each coding agent's id, name, route and context_floor, once for the list.

Both routes answer with the key's view. A model an access guardrail keeps out of this key's reach stays listed, with hips.allowed: false and the guardrail in hips.allowed_by, and hips.defaults.pools answers the pools left; so a client can tell an unknown model from one it may not name before sending a request. A model or a router the workspace's plan does not include is listed the same way, hips.allowed_by naming the plan and the lowest plan that includes it (Billing). GET /v1/models/{id} answers a router's name with or without its suffix. The catalog is the only source of names; it lists every model HIPS has published, each with its status.

Errors these routes can answer

StatusTypeCodeSituationRetry
403permission_errorkey_scope_deniedThe key's kind excludes the route: a retrieval key on any route but its batch and file reads; a key other than full writing a knowledge base's documentsNo
404not_found_errormodel_not_foundUnknown catalog id, alias, pinned id or dep_; another workspace's dep_; a name starting with hips-router that is not one of the four routersNo
  • Status
    403
    Type
    permission_error
    Code
    key_scope_denied
    Situation
    The key's kind excludes the route: a retrieval key on any route but its batch and file reads; a key other than full writing a knowledge base's documents
    Retry
    No
  • Status
    404
    Type
    not_found_error
    Code
    model_not_found
    Situation
    Unknown catalog id, alias, pinned id or dep_; another workspace's dep_; a name starting with hips-router that is not one of the four routers
    Retry
    No

Related sheets

  • Models and task guides
  • Semantic routing
Previous sheetCount tokens
Next sheetPrices API
Sheet
18 of 20
Detail
F
Updated
2026-11-14
Sign in to the Console

On this sheet

  1. The hips object on each entry
  2. Errors these routes can answer

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Ü