Quickstart
Set your gateway token and use https://ai.ubq.fi/v1 as the base URL.
export UOS_AI_TOKEN="..."
curl -sS https://ai.ubq.fi/v1/models \
-H "Authorization: Bearer $UOS_AI_TOKEN"Choose a model returned by GET /v1/models.
API keys and authentication
Get an API key from your UbiquityOS operator. Use it as a bearer token; client tokens are not forwarded upstream. Keep tokens out of chat, logs, and source code. Administrators manage keys in the protected admin console.
API behavior
Use POST /v1/chat/completions for the Chat Completions API or
POST /v1/responses for the Responses API. Both support streaming and documented function
tools. The OpenAPI 3.1 contract contains typed request fields, unique
operation identifiers, response envelopes, authentication, and rate-limit headers for tool-aware
clients.
Parse JSON error responses as an error object with a message, type, and code. A matching
If-None-Match request to GET /v1/models?client_version=X.Y.Z can return
304 Not Modified with no body; reuse the cached catalog instead of parsing a response body.
For a 429 error, honor Retry-After when present. When an enforced gateway key
window is authoritative, the response also includes RateLimit fields for self-throttling.
Try a request
Open Chat to test a request with your existing key.
Agent setup
Start with agent instructions, then the full guide. Use approved credentials and the documented inference endpoints.