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. Responses
(Detail C)
llms.txt

Responses

On this sheet5 sections
  1. The request
  2. The input items
  3. The answer
  4. Streaming
  5. Errors

OpenAI's Responses API, served so that OpenAI's SDKs and Codex run on HIPS's catalog models (decided 2026-10-29). The route is stateless: HIPS stores no response, so every request carries its whole conversation in input. The key, the requirement headers, the limits and the response headers are those of chat completions, and a field the route does not take is a 400 that names it.

POST/v1/responsesserved

OpenAI's Responses shape, stateless: HIPS stores no response, so every request carries its whole conversation.

F
Fig. 1, sheet 18API reference
00000000000000000000000000000000000000001{2  "model": "<catalog id>",3  "instructions": "Answer in one sentence.",4  "input": [5    {"role": "user", "content": [{"type": "input_text", "text": "What does a GPU do?"}]}6  ],7  "store": false8}
Language

The request

Parts list: Fields

  1. 01
    modelRequired

    A catalog id, an alias, a pinned id or a router name; unknown is a 404 model_not_found.

  2. 02
    inputRequired

    A string, read as one user message, or a non-empty list of the items below.

  3. 03
    instructionsAccepted

    A string, the conversation's first system message.

  4. 04
    streamAccepted

    true streams the events below; absent or false answers whole.

  5. 05
    storefalse accepted

    HIPS stores no response: false and the field's absence are accepted, and both read as false; true is a 400 stateful_not_supported.

  6. 06
    includeOne value accepted

    A list holding reasoning.encrypted_content: every reasoning item then answers encrypted_content: null, its text in the clear. Any other value is a 400 unsupported_value.

  7. 07
    toolsAccepted

    Function tools, {"type": "function", "name", "description", "parameters", "strict"}, on a model that advertises tools in the pool the request resolves to; a name of 1 to 64 characters. Any other type is a 400 unsupported_value at tools[<n>].type: HIPS runs no tool of its own on this route.

  8. 08
    tool_choiceAccepted

    auto, none, required or {"type": "function", "name"}; any other form is a 400 unsupported_value.

  9. 09
    parallel_tool_callsAccepted

    As on chat completions, a permission: true (what Codex sends on every request) allows more than one call where the model advertises parallel_tool_calls and is served as false, at most one call, where it does not, never refused for it; false asks for at most one call.

  10. 10
    reasoningAccepted

    effort is sent to the engine and needs the reasoning feature; summary (auto, concise, detailed or none) is accepted and writes nothing, since a model's reasoning comes back whole.

  11. 11
    textAccepted

    format: {"type": "text"}, or json_object and json_schema (name, schema, strict, description) on a model advertising them. verbosity is a 400 unsupported_parameter.

  12. 12
    max_output_tokensAccepted

    The output cap; over the model's max_output_tokens it is a 400 max_tokens_exceeded naming max_output_tokens.

  13. 13
    temperature, top_pAccepted

    Passed to the engine.

  14. 14
    prompt_cache_keyAccepted

    As on chat completions.

  15. 15
    truncationdisabled accepted

    HIPS never truncates a prompt; auto is a 400 unsupported_value.

  16. 16
    client_metadata, userAccepted, discarded

    Never stored, logged or sent to a worker.

  17. 17
    backgroundfalse accepted

    true is a 400 stateful_not_supported: every request is answered in its own connection.

  18. 18
    previous_response_id, conversation, metadataRejected, 400 stateful_not_supported

    Each names state HIPS does not keep.

  19. 19
    prompt_cache_retention, prompt_cache_options, prompt_cache_breakpoint, service_tier, prompt, max_tool_calls, top_logprobs, stream_optionsRejected, 400 unsupported_parameter

    No cache lifetime is promised, pools and pricing modes are headers, and the others are not carried on this route.

  20. 20
    cache_salt, hips and any other nameRejected, 400 unknown_parameter

    At every depth. Requirements ride as the x-hips-* headers.

The input items

ItemRule
messageRoles developer, system, user and assistant. content is a string or a list of parts: input_text in any role; input_image in a user message, inline as a data URI, on a model advertising vision; output_text in an assistant message. developer and system messages reach the model as system messages. id and status are accepted and read as nothing
reasoningAn earlier answer's reasoning, replayed: its shape checked, not sent to the worker
function_callA call the model made earlier: call_id, name, arguments
function_call_outputA call's result: output a string or a list of input_text and input_image parts
item_reference400 stateful_not_supported: it names a stored item
Any other type400 unsupported_value at input[<n>].type
  • Item
    message
    Rule
    Roles developer, system, user and assistant. content is a string or a list of parts: input_text in any role; input_image in a user message, inline as a data URI, on a model advertising vision; output_text in an assistant message. developer and system messages reach the model as system messages. id and status are accepted and read as nothing
  • Item
    reasoning
    Rule
    An earlier answer's reasoning, replayed: its shape checked, not sent to the worker
  • Item
    function_call
    Rule
    A call the model made earlier: call_id, name, arguments
  • Item
    function_call_output
    Rule
    A call's result: output a string or a list of input_text and input_image parts
  • Item
    item_reference
    Rule
    400 stateful_not_supported: it names a stored item
  • Item
    Any other type
    Rule
    400 unsupported_value at input[<n>].type

The answer

Parts list: The response object

  1. 01
    id

    The request id, req_..., as x-hips-request-id.

  2. 02
    status, incomplete_details

    completed and null; incomplete and {"reason": "max_output_tokens"} when the output cap ended the answer.

  3. 03
    model

    The pinned id served, as x-hips-model.

  4. 04
    output

    In this order: a reasoning item when the engine returned reasoning text (summary: [], content of reasoning_text, encrypted_content: null); a message item with the model's text; one function_call item per call, arguments the model's JSON string as written, never repaired. Ids are made from the request id (rs_, msg_, fc_).

  5. 05
    usage

    input_tokens (cached included), input_tokens_details.cached_tokens, output_tokens, output_tokens_details.reasoning_tokens where the engine counts them, total_tokens.

  6. 06
    store

    Always false.

Streaming

stream: true answers 200 with text/event-stream, each event as event: <type> and one data: line carrying its type and a sequence_number from 0, relayed as the engine writes it. Nothing is sent before a worker answers, so a refusal before the first byte is an ordinary status and body.

EventWhen
response.created, response.in_progressFirst: the response object with status: "in_progress", output: [] and usage: null
response.output_item.added, response.output_item.doneEach item as it opens and once it is complete
response.reasoning_text.delta, .doneA reasoning item's text, then whole
response.content_part.added, response.output_text.delta, response.output_text.done, response.content_part.doneA message's text part
response.function_call_arguments.delta, .doneA call's arguments, then whole
response.completedLast on every answer that ended, with every item, the usage and the hips object (cost_micros, latency_ms, quote). An answer the output cap ended is response.completed with status: "incomplete"; response.incomplete is never sent
response.failedA failure after the stream started: status: "failed", the items finished so far and error with code and message; the stream ends with it and nothing is billed
  • Event
    response.created, response.in_progress
    When
    First: the response object with status: "in_progress", output: [] and usage: null
  • Event
    response.output_item.added, response.output_item.done
    When
    Each item as it opens and once it is complete
  • Event
    response.reasoning_text.delta, .done
    When
    A reasoning item's text, then whole
  • Event
    response.content_part.added, response.output_text.delta, response.output_text.done, response.content_part.done
    When
    A message's text part
  • Event
    response.function_call_arguments.delta, .done
    When
    A call's arguments, then whole
  • Event
    response.completed
    When
    Last on every answer that ended, with every item, the usage and the hips object (cost_micros, latency_ms, quote). An answer the output cap ended is response.completed with status: "incomplete"; response.incomplete is never sent
  • Event
    response.failed
    When
    A failure after the stream started: status: "failed", the items finished so far and error with code and message; the stream ends with it and nothing is billed

A comment line (: keep-alive) goes out while nothing else has been sent for the keep-alive interval. Closing the connection cancels the work on the worker.

Errors

Every refusal is in the error envelope, and param names the field as this route names it (max_output_tokens, text.format.type, input[2].content[0].image_url). One is answered otherwise: a prompt longer than the model's context is, on a streamed request, 200 with response.created, response.in_progress and response.failed carrying context_length_exceeded, the one way Codex reads a request as over its context; on a whole request it is a 400 context_length_exceeded at input. The prompt is never truncated.

What is not served

RouteAnswer
GET, DELETE /v1/responses/{id}, POST /v1/responses/{id}/cancel, GET /v1/responses/{id}/input_items, POST /v1/responses/compact404 route_not_found: HIPS stores no response
GET /v1/responses404 method_not_allowed with Allow: POST
  • Route
    GET, DELETE /v1/responses/{id}, POST /v1/responses/{id}/cancel, GET /v1/responses/{id}/input_items, POST /v1/responses/compact
    Answer
    404 route_not_found: HIPS stores no response
  • Route
    GET /v1/responses
    Answer
    404 method_not_allowed with Allow: POST
StatusTypeCodeSituationRetry
400invalid_request_errorinvalid_jsonThe body is not JSON, or not an objectNo
400invalid_request_errormissing_required_parameterA required field or header is absent; param names itNo
400invalid_request_errorinvalid_typeA field has the wrong JSON typeNo
400invalid_request_errorinvalid_valueA value is out of range or malformed: stop with more than 16 entries, a prompt_cache_key over 512 characters, a string holding a lone surrogate escape, a router name with an empty or unknown suffix, both max_tokens names with different valuesNo
400invalid_request_errorunknown_parameterA field the gateway does not know, at any depth; param names itNo
400invalid_request_errorunsupported_parameterA known field HIPS does not accept, or a feature the named model does not advertise in the pool the request resolves to; param names it and message names the modelNo
400invalid_request_errorunsupported_valuen other than 1, stream_options without stream, a message role, part, item or tool type not accepted, a hosted tool that is not servedNo
400invalid_request_errorstateful_not_supportedState HIPS does not keep: store and metadata on chat completions; store: true, previous_response_id, conversation, metadata, background: true and item_reference on ResponsesNo
400invalid_request_errorcontext_length_exceededThe prompt is over the model's context_length, or over the largest window any GPU serves it at now, or held only in a size that the GPUs able to hold it keep failing to read within the time limit; that limit and the prompt's count in the message, the limit the largest size that works now for this request, never more than the pool's context_window on Models; the prompt is never truncated. On embeddings and rerank, an input longer than the model reads at once, never cutNo
400invalid_request_errormax_tokens_exceededmax_tokens (on Responses max_output_tokens) over the model's max_output_tokensNo
400invalid_request_errorrouter_no_candidateA router has no model it can choose for this request: none takes what the request carries (param the first field at fault) or none is allowed under its requirements (param the header); the message says why and what would serve it. Before any worker, unchargedNo
400invalid_request_errorguardrail_blockedA content moderation guardrail with block found prompt injection or a sensitive pattern; param names the message and the error's guardrail member names the guardrail, the check and the pattern's type, never the matched text. Before any model ran, unchargedNo
402insufficient_creditinsufficient_creditThe balance does not cover the request's maximum cost at the bound quoteAfter a top-up
402insufficient_creditbudget_exceededA budget guardrail of the workspace, the key or the person is at its limit with block; the error carries guardrail and resets_at (null for a budget that never resets). Never a payment challengeAfter resets_at, or once the limit is raised
403permission_errormodel_not_allowed, region_not_allowedA model, or a region requirement, that an access guardrail keeps out, the guardrail named in the error's guardrail memberNo
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
429rate_limit_errorrate_limit_exceededA rate limit; param is requests, tokens, uploads, batches (batches created per hour) or knowledge_search; Retry-AfterYes, after Retry-After
503overloaded_errorno_capacityNo eligible worker under the request's requirements, in any pool the requirements allow; Retry-After. The message says what those pools can do now: a GPU that fits the model takes it when free or loads it when asked, which can take minutes or longer; or nothing can serve it, and a retry sooner than the given delay gets the same answerYes, after the given delay
503overloaded_erroroverloadedEligible workers exist and every one is saturated, or the queue is full; Retry-AfterYes
500api_errorattempt_failedEvery attempt failed for a reason that is not the client's and retries are exhausted. Nothing billedOnce
  • Status
    400
    Type
    invalid_request_error
    Code
    invalid_json
    Situation
    The body is not JSON, or not an object
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    missing_required_parameter
    Situation
    A required field or header is absent; param names it
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    invalid_type
    Situation
    A field has the wrong JSON type
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    invalid_value
    Situation
    A value is out of range or malformed: stop with more than 16 entries, a prompt_cache_key over 512 characters, a string holding a lone surrogate escape, a router name with an empty or unknown suffix, both max_tokens names with different values
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    unknown_parameter
    Situation
    A field the gateway does not know, at any depth; param names it
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    unsupported_parameter
    Situation
    A known field HIPS does not accept, or a feature the named model does not advertise in the pool the request resolves to; param names it and message names the model
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    unsupported_value
    Situation
    n other than 1, stream_options without stream, a message role, part, item or tool type not accepted, a hosted tool that is not served
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    stateful_not_supported
    Situation
    State HIPS does not keep: store and metadata on chat completions; store: true, previous_response_id, conversation, metadata, background: true and item_reference on Responses
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    context_length_exceeded
    Situation
    The prompt is over the model's context_length, or over the largest window any GPU serves it at now, or held only in a size that the GPUs able to hold it keep failing to read within the time limit; that limit and the prompt's count in the message, the limit the largest size that works now for this request, never more than the pool's context_window on Models; the prompt is never truncated. On embeddings and rerank, an input longer than the model reads at once, never cut
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    max_tokens_exceeded
    Situation
    max_tokens (on Responses max_output_tokens) over the model's max_output_tokens
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    router_no_candidate
    Situation
    A router has no model it can choose for this request: none takes what the request carries (param the first field at fault) or none is allowed under its requirements (param the header); the message says why and what would serve it. Before any worker, uncharged
    Retry
    No
  • Status
    400
    Type
    invalid_request_error
    Code
    guardrail_blocked
    Situation
    A content moderation guardrail with block found prompt injection or a sensitive pattern; param names the message and the error's guardrail member names the guardrail, the check and the pattern's type, never the matched text. Before any model ran, uncharged
    Retry
    No
  • Status
    402
    Type
    insufficient_credit
    Code
    insufficient_credit
    Situation
    The balance does not cover the request's maximum cost at the bound quote
    Retry
    After a top-up
  • Status
    402
    Type
    insufficient_credit
    Code
    budget_exceeded
    Situation
    A budget guardrail of the workspace, the key or the person is at its limit with block; the error carries guardrail and resets_at (null for a budget that never resets). Never a payment challenge
    Retry
    After resets_at, or once the limit is raised
  • Status
    403
    Type
    permission_error
    Code
    model_not_allowed, region_not_allowed
    Situation
    A model, or a region requirement, that an access guardrail keeps out, the guardrail named in the error's guardrail member
    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
    429
    Type
    rate_limit_error
    Code
    rate_limit_exceeded
    Situation
    A rate limit; param is requests, tokens, uploads, batches (batches created per hour) or knowledge_search; Retry-After
    Retry
    Yes, after Retry-After
  • Status
    503
    Type
    overloaded_error
    Code
    no_capacity
    Situation
    No eligible worker under the request's requirements, in any pool the requirements allow; Retry-After. The message says what those pools can do now: a GPU that fits the model takes it when free or loads it when asked, which can take minutes or longer; or nothing can serve it, and a retry sooner than the given delay gets the same answer
    Retry
    Yes, after the given delay
  • Status
    503
    Type
    overloaded_error
    Code
    overloaded
    Situation
    Eligible workers exist and every one is saturated, or the queue is full; Retry-After
    Retry
    Yes
  • Status
    500
    Type
    api_error
    Code
    attempt_failed
    Situation
    Every attempt failed for a reason that is not the client's and retries are exhausted. Nothing billed
    Retry
    Once

Related sheets

  • Chat completions
  • Compatibility matrix
Previous sheetChat completions
Next sheetMessages
Sheet
18 of 20
Detail
C
Updated
2026-11-15
Sign in to the Console

On this sheet

  1. The request
  2. The input items
  3. The answer
  4. Streaming
  5. Errors

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Ü