API
TARX uses a stable request shape so developers can start locally and add approved capacity paths later.
The API docs are intentionally conservative until endpoint proof is refreshed. Use this page as the public-safe request contract, not a guarantee that every route, model, or hosted path is enabled for every account.
Local runtime
curl http://127.0.0.1:11440/v1/chat/completions \
-H "Content-Type: application/json" \
-d '{"model":"tarx-local","messages":[{"role":"user","content":"Hello"}]}'Model selection
| Scope | Model rule | Status |
|---|---|---|
| Local Computer | Use tarx-local so TARX selects the approved local model for this machine and policy. | Available now / Pilot-ready |
| Market-specific deployments | Use the approved local/open-weight family for that deployment; do not hard-code a family without runtime evidence. | Enterprise evaluation |
| BYO provider / private runtime | Use the customer-approved provider or model profile. | Enterprise evaluation |
| Hosted capacity | Use the account-approved hosted route and model profile. | Pilot-ready / permissioned |
Do not treat docs copy as the active model registry. The active model family, version, quantization, context limit, and route should come from runtime status, Evidence, or an authenticated capability/model registry.
Verify the route
| Need | Check |
|---|---|
| Local runtime is reachable | tarx status or the product status surface before calling localhost. |
| Model alias is allowed | Use tarx-local unless a policy-approved model is visible. |
| Hosted capacity is enabled | Confirm account entitlement, route policy, and Evidence. |
| Private context is allowed | Confirm the Space, file, memory, and approval boundary before sending context. |
Context limits
Context limits are model- and runtime-specific. TARX docs should not claim one fixed local context window for every deployment.
| Source | What it proves |
|---|---|
Runtime status / /v1/models when implemented | Active model alias, version, and context limit for the current route. |
| Evidence record | Which model/route actually handled a run. |
| Official model card | Upstream maximums for a model family, not necessarily TARX’s active usable limit. |
| Product UI | User-facing active limit when it is backed by runtime evidence. |
The active limit exposed by TARX may be lower than the model maximum when local hardware, quantization, or route policy requires it.
Hosted capacity
Hosted execution uses the same request shape when a TARX key and execution policy are enabled for the account.
Common error states
| State | Meaning | Action |
|---|---|---|
| Local runtime unavailable | TARX cannot prove the local Computer route. | Start Desktop/runtime or choose an approved hosted route. |
| Bridge unavailable | Local coordination path is not reachable. | Recheck Desktop status before making local-private claims. |
| Model unavailable | The selected model is not loaded or permitted. | Use tarx-local or wait for model readiness evidence. |
| Context denied | Space, file, memory, or Vault scope is not approved. | Ask for explicit approval or reduce scope. |
| Hosted route blocked | Account, budget, policy, or route evidence is missing. | Do not escalate; show the blocker. |
| Evidence missing | The result cannot be tied to route/context/tool proof. | Treat the run as unproven. |
Next steps
- Review MCP.
- Review BYO cloud and models.
Ready to try the request shape?
Request Mac access.
Verify the local route first. Hosted and private paths are added only when entitlement, policy, and Evidence allow them.