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. Deployments
(Detail H)

PreviewNot yet validated. Join early access

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 11API reference

How a deployment is addressed

Model typeFieldRoute
Customer-owned language modelmodel: "dep_..."POST /v1/chat/completions
Customer-owned model of any other typedeployment: "dep_..."POST /v1/tasks, POST /v1/jobs
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
  • Model type
    Customer-owned model of any other type
    Field
    deployment: "dep_..."
    Route
    POST /v1/tasks, POST /v1/jobs
  • 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 one entry per deployment of the key's workspace with owned_by the workspace's ws_ id and a hips.deployment object; GET /v1/models/{id} with the dep_ id returns it alone.

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 approved pool only.

  4. 04
    deployment.poolpersonal or approved

    Customer-owned models run in the approved 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.

Errors a deployment can answer

StatusTypeCodeSituationRetry
400invalid_request_errornot_a_language_modelA task model or a task-model deployment named on an OpenAI-compatible routeNo
400invalid_request_errordeployment_stoppedThe dep_ is in stopped; start it in the ConsoleNo
403permission_errorpool_not_allowedA pool the workspace may not use for this modelNo
404not_found_errormodel_not_foundUnknown catalog id, alias, pinned id or dep_; another workspace's dep_No
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 or a task-model deployment 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
    pool_not_allowed
    Situation
    A pool the workspace may not use for this model
    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_
    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 sheetUploads
Next sheetRequirements and headers
Sheet
11 of 13
Detail
H
Updated
2026-10-21
Status
Preview
Join early access

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 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Ü