Skip to content
ShopAssist Docs
AIOpenAI-compatible

OpenAI-compatible endpoints

Connect any endpoint that speaks the OpenAI Chat Completions API: hosted routers and inference services, or your own server.

Many services and self-hosted servers expose the OpenAI Chat Completions API. ShopAssist can use them if the model supports tool calling.

Presets

PresetBase URLGuide
OpenRouterhttps://openrouter.ai/api/v1OpenRouter
Groqhttps://api.groq.com/openai/v1Groq
Togetherhttps://api.together.xyz/v1Together
Ollama (cloud)https://ollama.com/v1Ollama
Ollama (self-hosted)Your public HTTPS URLOllama
vLLMYour public HTTPS URLvLLM
LM StudioYour public HTTPS URLLM Studio
CustomYour public HTTPS URLbelow

Fields

FieldNotes
Base URLFixed for hosted presets; for your own server: HTTPS on port 443, a public address, no query string
API keySent as Authorization: Bearer …
Extra headers (optional)Up to 3 headers for an access proxy, for example Cloudflare Access service tokens
ModelAny model id the endpoint serves (up to 128 characters)
Context window (optional)The model's context size, if the endpoint doesn't report it

Self-hosted endpoints

ShopAssist calls your endpoint from its egress IPs. The endpoint must be reachable over public HTTPS with authentication; private addresses, plain HTTP and non-standard ports are refused (endpoint_blocked). Put the server behind a reverse proxy with TLS and an API key or access proxy.

Self-hosted endpoints run the extra context check: a fact at the start of an 8,000-token prompt must be recalled. Many servers truncate long prompts by default (context_too_small).

Models

Any model your endpoint serves that supports tool calling.

Data location

Data location

Data goes wherever this endpoint runs. Self-hosted endpoints must be reachable over HTTPS with authentication.

Connection test

Checks run by Test connection
CheckRequiredWhat it testsOn failure
authYesThe key is accepted (lists models or sends a tiny request)auth_failed, insufficient_quota, gemini_free_tier, endpoint_blocked, provider_unavailable, model_not_found
toolsYesThe model calls a tool with valid arguments and continues after the resulttools_unsupported: the model can't run the shopping tools
ttftNo (degraded)The first answer event arrives within 8 secondsttft_slow: works, but shoppers wait
parallel_toolsNoTwo tools are called in one stepparallel_tools_unsupported: slightly slower answers
visionNoThe model names the colour of a test imagevision_unsupported: visual search is off
contextSelf-hosted onlyA fact at the start of an 8,000-token prompt is recalledcontext_too_small: the endpoint truncates prompts

Last updated on

On this page