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
llms.txt

HIPS API reference

On this sheet2 sections
  1. Routes
  2. Pages

The public wire contract, rendered: the OpenAI-compatible routes for open-weight language models, Anthropic's Messages API, embeddings and rerank, OpenAI's image routes, the HIPS task API for every other model type, the request requirements, the response headers, the error envelope, usage and versioning. Every route is relative to the base URL https://ai.hips.com/v1, the value of HIPS_BASE_URL; HTTPS only; JSON bodies with Content-Type: application/json, except streaming responses (text/event-stream).

Note

The routes marked served answer in production today, with an API key created in the Console. A route's state in production is not its validation: every row of the compatibility matrix stays unvalidated until it passes the conformance suite. The reference never shows a value that could be mistaken for a working credential, host or model id.

F
Fig. 1, sheet 18API reference

Routes

Method and pathPurposeIn production
POST /v1/chat/completionsChat completion in OpenAI's shape, streamed or not.served
POST /v1/responsesOpenAI's Responses shape, stateless: HIPS stores no response, so every request carries its whole conversation.served
POST /v1/messagesAnthropic's Messages API, with x-api-key and anthropic-version: 2023-06-01, in Anthropic's error shape.served
POST /v1/messages/count_tokensAnswers 404 route_not_available in Anthropic's shape: each answer's usage carries the exact counts.not served
GET /v1/modelsThe routers, models and deployments the key may name, with the hips extensions.served
GET /v1/models/{id}One entry of the list, by catalog id, pinned id, router name or dep_ id.served
GET /v1/feeds/certified/modelsThe Certified pool's price feed: one document per model under <model id>:certified, with no key.served
GET /v1/feeds/community/modelsThe Community pool's price feed: one document per model under <model id>:community, with no key.served
GET /v1/feeds/modelsBoth pools' price feeds in one: the Community offer as service_tier: "flex" under the Certified offer's id, with no key.served
POST /v1/embeddingsEmbeddings in OpenAI's shape, billed per started second of compute. A model answers once an embedding model is published and priced.served
POST /v1/rerankRerank in Cohere's shape, billed per started second of compute. A model answers once a reranker is published and priced.served
POST /v1/tasksA synchronous task: one request, one batch of inputs, one result array.served
POST /v1/audio/transcriptionsAnswers 400 type_not_served: no speech-to-text model is served yet. Opens once the type is served.not served
POST /v1/audio/speechAnswers 400 type_not_served: no text-to-speech model is served yet. Opens once the type is served.not served
POST /v1/images/generationsImage generation in OpenAI's JSON shape, billed per image at its size. Answers 400 type_not_served while no image generation model is served.served
POST /v1/images/editsImage editing in OpenAI's multipart shape, billed per image at its size. Answers 400 type_not_served while no image editing model is served.served
POST /v1/uploadsA presigned PUT for a task input. Not offered in production yet: 404 route_not_available.not offered
GET /v1/uploads/{id}The upload's status. Not offered in production yet: 404 route_not_available.not offered
DELETE /v1/uploads/{id}Deletes the upload and its bytes. Not offered in production yet: 404 route_not_available.not offered
POST /v1/filesOpenAI's Files API for batch input files. Not offered in production yet: 404 route_not_available.not offered
GET /v1/filesThe files the credential reaches, OpenAI's list. Not offered in production yet.not offered
GET /v1/files/{file_id}The File object. Not offered in production yet.not offered
GET /v1/files/{file_id}/contentThe file's bytes, streamed. Not offered in production yet.not offered
DELETE /v1/files/{file_id}Deletes the file from storage at once. Not offered in production yet.not offered
POST /v1/batchesOpenAI's Batch API. Not offered in production yet: 404 route_not_available.not offered
GET /v1/batchesThe batches the credential reaches, newest first. Not offered in production yet.not offered
GET /v1/batches/{batch_id}The Batch object. Not offered in production yet.not offered
POST /v1/batches/{batch_id}/cancelCancels a batch. Not offered in production yet.not offered
POST /v1/jobsThe asynchronous job route is not built: 404 route_not_found.not built
GET /v1/jobs/{id}Not built: 404 route_not_found.not built
GET /v1/jobsNot built: 404 route_not_found.not built
POST /v1/jobs/{id}/cancelNot built: 404 route_not_found.not built
  • Method and path
    POST /v1/chat/completions
    Purpose
    Chat completion in OpenAI's shape, streamed or not.
    In production
    served
  • Method and path
    POST /v1/responses
    Purpose
    OpenAI's Responses shape, stateless: HIPS stores no response, so every request carries its whole conversation.
    In production
    served
  • Method and path
    POST /v1/messages
    Purpose
    Anthropic's Messages API, with x-api-key and anthropic-version: 2023-06-01, in Anthropic's error shape.
    In production
    served
  • Method and path
    POST /v1/messages/count_tokens
    Purpose
    Answers 404 route_not_available in Anthropic's shape: each answer's usage carries the exact counts.
    In production
    not served
  • Method and path
    GET /v1/models
    Purpose
    The routers, models and deployments the key may name, with the hips extensions.
    In production
    served
  • Method and path
    GET /v1/models/{id}
    Purpose
    One entry of the list, by catalog id, pinned id, router name or dep_ id.
    In production
    served
  • Method and path
    GET /v1/feeds/certified/models
    Purpose
    The Certified pool's price feed: one document per model under <model id>:certified, with no key.
    In production
    served
  • Method and path
    GET /v1/feeds/community/models
    Purpose
    The Community pool's price feed: one document per model under <model id>:community, with no key.
    In production
    served
  • Method and path
    GET /v1/feeds/models
    Purpose
    Both pools' price feeds in one: the Community offer as service_tier: "flex" under the Certified offer's id, with no key.
    In production
    served
  • Method and path
    POST /v1/embeddings
    Purpose
    Embeddings in OpenAI's shape, billed per started second of compute. A model answers once an embedding model is published and priced.
    In production
    served
  • Method and path
    POST /v1/rerank
    Purpose
    Rerank in Cohere's shape, billed per started second of compute. A model answers once a reranker is published and priced.
    In production
    served
  • Method and path
    POST /v1/tasks
    Purpose
    A synchronous task: one request, one batch of inputs, one result array.
    In production
    served
  • Method and path
    POST /v1/audio/transcriptions
    Purpose
    Answers 400 type_not_served: no speech-to-text model is served yet. Opens once the type is served.
    In production
    not served
  • Method and path
    POST /v1/audio/speech
    Purpose
    Answers 400 type_not_served: no text-to-speech model is served yet. Opens once the type is served.
    In production
    not served
  • Method and path
    POST /v1/images/generations
    Purpose
    Image generation in OpenAI's JSON shape, billed per image at its size. Answers 400 type_not_served while no image generation model is served.
    In production
    served
  • Method and path
    POST /v1/images/edits
    Purpose
    Image editing in OpenAI's multipart shape, billed per image at its size. Answers 400 type_not_served while no image editing model is served.
    In production
    served
  • Method and path
    POST /v1/uploads
    Purpose
    A presigned PUT for a task input. Not offered in production yet: 404 route_not_available.
    In production
    not offered
  • Method and path
    GET /v1/uploads/{id}
    Purpose
    The upload's status. Not offered in production yet: 404 route_not_available.
    In production
    not offered
  • Method and path
    DELETE /v1/uploads/{id}
    Purpose
    Deletes the upload and its bytes. Not offered in production yet: 404 route_not_available.
    In production
    not offered
  • Method and path
    POST /v1/files
    Purpose
    OpenAI's Files API for batch input files. Not offered in production yet: 404 route_not_available.
    In production
    not offered
  • Method and path
    GET /v1/files
    Purpose
    The files the credential reaches, OpenAI's list. Not offered in production yet.
    In production
    not offered
  • Method and path
    GET /v1/files/{file_id}
    Purpose
    The File object. Not offered in production yet.
    In production
    not offered
  • Method and path
    GET /v1/files/{file_id}/content
    Purpose
    The file's bytes, streamed. Not offered in production yet.
    In production
    not offered
  • Method and path
    DELETE /v1/files/{file_id}
    Purpose
    Deletes the file from storage at once. Not offered in production yet.
    In production
    not offered
  • Method and path
    POST /v1/batches
    Purpose
    OpenAI's Batch API. Not offered in production yet: 404 route_not_available.
    In production
    not offered
  • Method and path
    GET /v1/batches
    Purpose
    The batches the credential reaches, newest first. Not offered in production yet.
    In production
    not offered
  • Method and path
    GET /v1/batches/{batch_id}
    Purpose
    The Batch object. Not offered in production yet.
    In production
    not offered
  • Method and path
    POST /v1/batches/{batch_id}/cancel
    Purpose
    Cancels a batch. Not offered in production yet.
    In production
    not offered
  • Method and path
    POST /v1/jobs
    Purpose
    The asynchronous job route is not built: 404 route_not_found.
    In production
    not built
  • Method and path
    GET /v1/jobs/{id}
    Purpose
    Not built: 404 route_not_found.
    In production
    not built
  • Method and path
    GET /v1/jobs
    Purpose
    Not built: 404 route_not_found.
    In production
    not built
  • Method and path
    POST /v1/jobs/{id}/cancel
    Purpose
    Not built: 404 route_not_found.
    In production
    not built
StateWhat a caller gets
servedThe route answers in production.
not offeredBuilt and not switched on in production: 404 route_not_available (uploads, files, batches).
not servedThe route answers a refusal until its type is served or its build lands: 400 type_not_served, or 404 route_not_available.
not builtNo route exists: 404 route_not_found.
  • State
    served
    What a caller gets
    The route answers in production.
  • State
    not offered
    What a caller gets
    Built and not switched on in production: 404 route_not_available (uploads, files, batches).
  • State
    not served
    What a caller gets
    The route answers a refusal until its type is served or its build lands: 400 type_not_served, or 404 route_not_available.
  • State
    not built
    What a caller gets
    No route exists: 404 route_not_found.

Every other path, OpenAI's and Anthropic's included (/v1/fine_tuning/*, /v1/assistants, realtime, /v1/messages/batches, a stored response under /v1/responses/), answers 404 route_not_found; a known path with another method answers 404 method_not_allowed with Allow.

Pages

PageCarries
AuthenticationAPI keys and a person's access token, Authorization: Bearer, key kinds, workspace state
Chat completionsPOST /v1/chat/completions, every field, the model values, streaming, features
ResponsesPOST /v1/responses: the stateless request, the output items, the streamed events
MessagesPOST /v1/messages: Anthropic's Messages API, its headers, events and error shape
Count tokensPOST /v1/messages/count_tokens, not served yet
ModelsGET /v1/models, GET /v1/models/{id} and the hips entry
Prices APIHIPS's published prices by machine, on https://hips.com with no key: the catalog, one model's rates and the price history
TasksPOST /v1/tasks: the envelope, the task types, per-input errors
Embeddings and rerankPOST /v1/embeddings in OpenAI's shape and POST /v1/rerank in Cohere's, billed per started second
ImagesPOST /v1/images/generations and POST /v1/images/edits in OpenAI's shapes, billed per image at its size
JobsThe asynchronous job routes, not built yet
UploadsPOST /v1/uploads: the presigned PUT, purposes, statuses; not offered in production yet
FilesOpenAI's Files API for batch files; not offered in production yet
BatchesOpenAI's Batch API and the Batch object; not offered in production yet
WebhooksThe batch events, their signatures and the Console's endpoint tools
Vector storesOpenAI's vector store API for Knowledge; not switched on in production yet
DeploymentsThe read side; dep_ ids in model and in deployment
Requirements and headersThe four requirements, the hips body object, every request and response header
ErrorsThe envelope and every type and code
UsageUsage fields per billing unit; money separate from units
VersioningHow the contract is versioned and deprecated
  • Page
    Authentication
    Carries
    API keys and a person's access token, Authorization: Bearer, key kinds, workspace state
  • Page
    Chat completions
    Carries
    POST /v1/chat/completions, every field, the model values, streaming, features
  • Page
    Responses
    Carries
    POST /v1/responses: the stateless request, the output items, the streamed events
  • Page
    Messages
    Carries
    POST /v1/messages: Anthropic's Messages API, its headers, events and error shape
  • Page
    Count tokens
    Carries
    POST /v1/messages/count_tokens, not served yet
  • Page
    Models
    Carries
    GET /v1/models, GET /v1/models/{id} and the hips entry
  • Page
    Prices API
    Carries
    HIPS's published prices by machine, on https://hips.com with no key: the catalog, one model's rates and the price history
  • Page
    Tasks
    Carries
    POST /v1/tasks: the envelope, the task types, per-input errors
  • Page
    Embeddings and rerank
    Carries
    POST /v1/embeddings in OpenAI's shape and POST /v1/rerank in Cohere's, billed per started second
  • Page
    Images
    Carries
    POST /v1/images/generations and POST /v1/images/edits in OpenAI's shapes, billed per image at its size
  • Page
    Jobs
    Carries
    The asynchronous job routes, not built yet
  • Page
    Uploads
    Carries
    POST /v1/uploads: the presigned PUT, purposes, statuses; not offered in production yet
  • Page
    Files
    Carries
    OpenAI's Files API for batch files; not offered in production yet
  • Page
    Batches
    Carries
    OpenAI's Batch API and the Batch object; not offered in production yet
  • Page
    Webhooks
    Carries
    The batch events, their signatures and the Console's endpoint tools
  • Page
    Vector stores
    Carries
    OpenAI's vector store API for Knowledge; not switched on in production yet
  • Page
    Deployments
    Carries
    The read side; dep_ ids in model and in deployment
  • Page
    Requirements and headers
    Carries
    The four requirements, the hips body object, every request and response header
  • Page
    Errors
    Carries
    The envelope and every type and code
  • Page
    Usage
    Carries
    Usage fields per billing unit; money separate from units
  • Page
    Versioning
    Carries
    How the contract is versioned and deprecated

Related sheets

  • Operating guidance
Previous sheetKnowledge
Next sheetAuthentication
Sheet
18 of 20
Updated
2026-11-16
Sign in to the Console

On this sheet

  1. Routes
  2. Pages

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Ü