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. Deployments
(Detail Q)
llms.txt

Deployments

On this sheet4 sections
  1. How a deployment is addressed
  2. Reading a deployment
  3. Requirements on a deployment
  4. Errors a deployment can answer

A deployment (dep_) is a customer model version made runnable, or a catalog model pinned to an always-on allocation. It is created in the Console in the first version (a public route is open Not decided yet); the API reads it and addresses it.

F
Fig. 1, sheet 18API reference

How a deployment is addressed

Model typeFieldRoute
Customer-owned language modelmodel: "dep_..."POST /v1/chat/completions: not served yet; the dep_ answers 404 model_not_found
Customer-owned model of any other typedeployment: "dep_..."POST /v1/tasks
A catalog model pinned to an always-on allocationmodel: "dep_..."The model's route
  • Model type
    Customer-owned language model
    Field
    model: "dep_..."
    Route
    POST /v1/chat/completions: not served yet; the dep_ answers 404 model_not_found
  • Model type
    Customer-owned model of any other type
    Field
    deployment: "dep_..."
    Route
    POST /v1/tasks
  • Model type
    A catalog model pinned to an always-on allocation
    Field
    model: "dep_..."
    Route
    The model's route

A dep_ in model on the task API is a 400 invalid_value that points at deployment; a task-model deployment named on an OpenAI-compatible route is a 400 not_a_language_model.

Reading a deployment

GET /v1/models lists no deployment yet: a deployment's state is read in the Console, and a request naming it answers by its state as below.

Parts list: The deployment object

  1. 01
    deployment.stateallocating, loading, ready, busy, degraded, stopped, or tariff_pending

    Every transition is timestamped and explained in the Console. Allocation is not readiness. A shared deployment created before its version's tariff waits in tariff_pending: it takes no request, a request naming it answers 503 deployment_not_ready, and nothing is charged.

  2. 02
    deployment.model

    The customer model version (mdl_ and its version) or the catalog pinned id.

  3. 03
    deployment.laneshared or always_on

    always_on exists in the certified pool only.

  4. 04
    deployment.poolcommunity or certified

    Customer-owned models run in the certified pool only at launch.

  5. 05
    deployment.since

    When the current state was entered.

Requirements on a deployment

The deployment's pool came with disclosed access conditions and fallback is set on the deployment: a request header or hips field may turn fallback off but never on; fallback: true on such a request is a 400 requirement_conflict. x-hips-deployment on the response carries the dep_ id; x-hips-lane reports the lane.

Deploying own models needs a plan that includes it, Business today: on any other plan a request naming the workspace's dep_ answers 403 model_not_on_plan with feature: "deployments" before its state is read, and the deployment is kept and answers again once the workspace is on such a plan. An always-on deployment of a workspace that drops below it is stopped by the platform, its capacity released and its charges ended, and its owners and admins are told; an owner starts it again once the plan is back.

Errors a deployment can answer

StatusTypeCodeSituationRetry
400invalid_request_errornot_a_language_modelA task model named on an OpenAI-compatible routeNo
400invalid_request_errordeployment_stoppedThe dep_ is in stopped; start it in the ConsoleNo
403permission_errormodel_not_on_planA model or feature the workspace's plan does not include, read from the plan's terms: on Free a model outside the Free plan's models (today gemma-4-e4b-it-8b, gpt-oss-120b, gpt-oss-20b and qwen3-14b), a router or Knowledge; on Free and Pro a deployment (dep_). The error adds feature and required_plan, the lowest plan that includes it. Answered before any placement, uncharged. A deployment refused this way is kept and answers again once the workspace is on a plan with deploymentsAfter an owner or admin chooses a plan that includes it
403permission_errorpool_not_allowedA pool the workspace may not use for this model: one an access guardrail keeps out (named in the error), or a customer model's pool whose runtime-access conditions were not acceptedNo
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
503overloaded_errordeployment_not_readyThe dep_ is allocating or loading, or waits for its version's tariff (tariff_pending); Retry-AfterYes
  • Status
    400
    Type
    invalid_request_error
    Code
    not_a_language_model
    Situation
    A task model named on an OpenAI-compatible route
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    deployment_stopped
    Situation
    The dep_ is in stopped; start it in the Console
    Retry
    No
  • Status
    403
    Type
    permission_error
    Code
    model_not_on_plan
    Situation
    A model or feature the workspace's plan does not include, read from the plan's terms: on Free a model outside the Free plan's models (today gemma-4-e4b-it-8b, gpt-oss-120b, gpt-oss-20b and qwen3-14b), a router or Knowledge; on Free and Pro a deployment (dep_). The error adds feature and required_plan, the lowest plan that includes it. Answered before any placement, uncharged. A deployment refused this way is kept and answers again once the workspace is on a plan with deployments
    Retry
    After an owner or admin chooses a plan that includes it
  • Status
    403
    Type
    permission_error
    Code
    pool_not_allowed
    Situation
    A pool the workspace may not use for this model: one an access guardrail keeps out (named in the error), or a customer model's pool whose runtime-access conditions were not accepted
    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
  • Status
    503
    Type
    overloaded_error
    Code
    deployment_not_ready
    Situation
    The dep_ is allocating or loading, or waits for its version's tariff (tariff_pending); Retry-After
    Retry
    Yes

Related sheets

  • Import and run your model
Previous sheetVector stores
Next sheetRequirements and headers
Sheet
18 of 20
Detail
Q
Updated
2026-11-12
Sign in to the Console

On this sheet

  1. How a deployment is addressed
  2. Reading a deployment
  3. Requirements on a deployment
  4. Errors a deployment 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Ü