Skip to main content

Hindsight Inference API

The Hindsight Inference API serves the models behind Hindsight's own retrieval to your applications directly:

APIEndpointDefault modelCompatible with
EmbeddingsPOST /v1/embeddingshs-embed-1OpenAI Embeddings
RerankingPOST /v1/rerankhs-decide-1-flashCohere Rerank
Decision modelsPOST /v1/systemonehs-decide-1-flashTypeSafe System One

Each speaks a format you probably already use, so in most cases you switch by changing the base URL and API key in a client you already have.

  • Embeddings turn text into vectors for search and clustering.
  • Reranking orders candidate documents by relevance to a query.
  • Decision models answer typed questions about a text: which option applies, or where on a scale it sits.

Base URL​

https://inference.hindsight.vectorize.io/v1

One account, one balance​

The Inference API uses the same organization, API keys and credit balance as Hindsight Cloud — there is no separate signup or wallet. A single balance covers both memory operations and inference calls. See Pricing & billing.

Getting started​

  1. Sign in to the Inference console with your Hindsight account.
  2. Create an API key under API Keys (see Authentication).
  3. Point a client at the base URL above and call one of the APIs:
curl https://inference.hindsight.vectorize.io/v1/embeddings \
-H "Authorization: Bearer $HINDSIGHT_API_KEY" \
-H "Content-Type: application/json" \
-d '{"model": "hs-embed-1", "input": "Agent memory that learns."}'

What's available​

The models your key can call are listed by GET /v1/models, and the console's Models page is built from it. At launch the API serves embeddings, reranking and decision models; chat/generation models stay internal to Hindsight and are not sold through the API.

API reference​

The full contract — every endpoint, its request and response shapes, and the error codes — is published as an OpenAPI 3.1 document. No API key is needed to fetch it:

curl https://inference.hindsight.vectorize.io/v1/openapi.json

Point Swagger UI, Redoc, or a client generator at it to explore or integrate. It lists the same endpoints your deployment serves to API keys.

Errors​

Errors return a JSON body with a detail message.

StatusMeaningWhat to do
400Invalid request (missing field, too many items, bad option)Fix the request; detail names the field
401Missing, invalid, revoked or expired API keyCheck the Authorization header
402Not enough credits for this requestTop up from Billing (see Pricing & billing)
403The key has no inference accessUse a key from the Inference console's API Keys (see Authentication)
404Unknown modelUse a model ID from GET /v1/models
429Capacity is busyRetry after the Retry-After header (seconds)
502The model backend failedRetry; contact support if it persists
503Authentication or billing is briefly unavailableRetry shortly