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. Authentication
(Detail A)
llms.txt

Authentication

The API takes two bearer credentials: an API key, a workspace's server-to-server credential for the inference API and the SDKs, and a person's access token, issued to the person's own tools by sign-in. Use a key for a server or an SDK; hi and HIPS Code sign in. Every request is attributed to one workspace and one plan; the plan decides limits and which requirements are allowed.

F
Fig. 1, sheet 18API reference

Parts list: Authentication

  1. 01
    Credential

    Authorization: Bearer followed by the key. Created in the Console's API keys view, named, of a kind, shown once, stored as a hash. Public id key_. The key's value is read from HIPS_API_KEY; no key value appears on any page.

  2. 02
    Where keys live

    On the server or in a secret store. Keep keys on the server or in an appropriate secret store, rather than shipping them in a public browser application. The gateway sends no cross-origin headers for live keys Not decided yet.

  3. 03
    Publishable keys

    Reserved for a later browser path and not part of this version of the contract Not decided yet.

  4. 04
    A person's tools

    The hi CLI, the provider app and HIPS Code need no API key: they sign in as the person with OAuth 2.0 device authorization. The tool shows a user code XXXX-XXXX and its link, the person approves it in the Console while signed in and chooses the workspace, and the tool receives a short-lived, scoped access token with a refresh token. The gateway accepts that token as the bearer beside API keys and attributes usage to the chosen workspace. The access token lasts 1 hour and the refresh token 30 days, replaced on each use; an expired access token answers 401 token_expired, and a token without the inference scope 403 insufficient_scope. The steps are on Sign in with device authorization.

  5. 05
    Key defaults

    Each key carries defaults for the four request requirements (pool, pricing mode, region, fallback), set in the Console.

  6. 06
    Key kindfull or inference_only

    Fixed at creation. Both reach every route of the API: chat completions, Responses, Messages, models, embeddings, rerank, tasks, and uploads, files and batches where they are offered. A full key reads and deletes every upload, file and batch of its workspace; an inference_only key, like a person's token, only those it created. Writing a knowledge base's documents needs a full key or a person whose role writes, once Knowledge is switched on. A route the kind excludes is a 403 key_scope_denied. Which models a key may name is set with an access guardrail assigned to the key.

  7. 07
    Workspace state

    A key of a paused or deleted workspace answers 403 workspace_suspended on every route; a key of a workspace whose owner cannot use HIPS answers 403 permission_error with the code account_restricted. While identity verification is on, a key of a workspace whose owner has not passed it answers 403 permission_error with the code workspace_unverified; identity verification is switched off since 2026-11-09, so that code is not sent now.

Errors this page can answer

StatusTypeCodeSituationRetry
401authentication_errormissing_api_keyNo Authorization header, or not a bearer (on Messages, no x-api-key either)No
401authentication_errorinvalid_api_keyUnknown, malformed or revoked key or person's token; on Messages, x-api-key and Authorization carrying different values. The message never says whichNo
401authentication_errortoken_expiredA person's access token past its life; the tool refreshes it and sends the request againAfter the refresh
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
403permission_errorinsufficient_scopeA person's access token without the inference scopeNo; sign the tool in with the scope
403permission_errorworkspace_unverifiedThe workspace's owner has not passed identity verification; the message names the Console's verification screen. Not sent while identity verification is switched off, as it is since 2026-11-09; documented for when it is switched back onAfter verification
403permission_errormember_unverifiedA person's access token whose person has not passed identity verification. Not sent while identity verification is switched off, as it is since 2026-11-09; documented for when it is switched back onAfter verification
403permission_erroraccount_restrictedThe workspace's owner, or the person a token belongs to, cannot use HIPS. The message says to contact HIPS supportNo; contact support
403workspace_suspendedworkspace_pausedThe workspace is paused: by balance, by an administrator, by a dispute, by a budget hard stop or by an owner. The message says where to resolve itAfter resolution
403workspace_suspendedplan_lapsedA lapse no longer pauses a workspace: a lapsed or canceled paid plan, or an ended plan grant, moves it to the free plan at once. Only a workspace a lapse paused before then answers this, until the platform moves it to the free plan within about a minuteAfter about a minute
403workspace_suspendedworkspace_deletedThe workspace is deleted (restorable 30 days)After restore
  • Status
    401
    Type
    authentication_error
    Code
    missing_api_key
    Situation
    No Authorization header, or not a bearer (on Messages, no x-api-key either)
    Retry
    No
  • Status
    401
    Type
    authentication_error
    Code
    invalid_api_key
    Situation
    Unknown, malformed or revoked key or person's token; on Messages, x-api-key and Authorization carrying different values. The message never says which
    Retry
    No
  • Status
    401
    Type
    authentication_error
    Code
    token_expired
    Situation
    A person's access token past its life; the tool refreshes it and sends the request again
    Retry
    After the refresh
  • 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
    403
    Type
    permission_error
    Code
    insufficient_scope
    Situation
    A person's access token without the inference scope
    Retry
    No; sign the tool in with the scope
  • Status
    403
    Type
    permission_error
    Code
    workspace_unverified
    Situation
    The workspace's owner has not passed identity verification; the message names the Console's verification screen. Not sent while identity verification is switched off, as it is since 2026-11-09; documented for when it is switched back on
    Retry
    After verification
  • Status
    403
    Type
    permission_error
    Code
    member_unverified
    Situation
    A person's access token whose person has not passed identity verification. Not sent while identity verification is switched off, as it is since 2026-11-09; documented for when it is switched back on
    Retry
    After verification
  • Status
    403
    Type
    permission_error
    Code
    account_restricted
    Situation
    The workspace's owner, or the person a token belongs to, cannot use HIPS. The message says to contact HIPS support
    Retry
    No; contact support
  • Status
    403
    Type
    workspace_suspended
    Code
    workspace_paused
    Situation
    The workspace is paused: by balance, by an administrator, by a dispute, by a budget hard stop or by an owner. The message says where to resolve it
    Retry
    After resolution
  • Status
    403
    Type
    workspace_suspended
    Code
    plan_lapsed
    Situation
    A lapse no longer pauses a workspace: a lapsed or canceled paid plan, or an ended plan grant, moves it to the free plan at once. Only a workspace a lapse paused before then answers this, until the platform moves it to the free plan within about a minute
    Retry
    After about a minute
  • Status
    403
    Type
    workspace_suspended
    Code
    workspace_deleted
    Situation
    The workspace is deleted (restorable 30 days)
    Retry
    After restore

Related sheets

  • Requirements and headers
Previous sheetOverview
Next sheetChat completions
Sheet
18 of 20
Detail
A
Updated
2026-11-14
Sign in to the Console

On this sheet

  1. Errors this page 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Ü