Ambient Desktop Docs
Quickstart Download ambient.xyz
Reference

API And Endpoints

Ambient's inference API is OpenAI-compatible. Point Ambient Desktop or any agent at one base URL, call the included models, and get zero-data-retention inference.

One endpoint, any agent

Ambient serves a standard, OpenAI-compatible inference API. If a tool can talk to OpenAI, it can talk to Ambient — change the base URL and the key, keep everything else the same. The same endpoint powers Ambient Desktop and any agent you already use, and every request is zero data retention.

SettingValue
Base URLhttps://api.ambient.xyz/v1
ProtocolOpenAI Chat Completions compatible (Anthropic Messages format also supported)
Auth headerAuthorization: Bearer <your key>
API keysapp.ambient.xyz/keys
Data retentionZero — see Privacy & Data Retention
PaymentsSubscription plans ($1–$200), or pay-per-use via x402 on Solana and Base

Get an API key

  1. Sign up

    Create an account at app.ambient.xyz.

  2. Create a key

    Generate an API key at app.ambient.xyz/keys and copy it somewhere safe — you send it as a Bearer token.

  3. Keep it out of your code

    Set it as an environment variable (for example AMBIENT_KEY) rather than hard-coding it. In Ambient Desktop you simply sign in — the app manages the key for you.

Models

Two models are available out of the box. Pass the model ID as the model field.

ModelModel IDBest for
GLM-5.1 FP8zai-org/GLM-5.1-FP8Default — fast, capable, tuned for agentic coding and tool use
Kimi K2.7 Codemoonshotai/kimi-k2.7-codeStrong coding-focused alternative

Quickstart

A first call in three flavors. Swap the model ID to switch models, and add "stream": true (or stream=True) for token streaming.

curl
curl https://api.ambient.xyz/v1/chat/completions \
  -H "Authorization: Bearer $AMBIENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "zai-org/GLM-5.1-FP8",
    "messages": [{"role": "user", "content": "Say hello from Ambient."}]
  }'
Python (openai SDK)
from openai import OpenAI

client = OpenAI(
    base_url="https://api.ambient.xyz/v1",
    api_key="YOUR_AMBIENT_KEY",  # create one at https://app.ambient.xyz/keys
)

resp = client.chat.completions.create(
    model="zai-org/GLM-5.1-FP8",          # or "moonshotai/kimi-k2.7-code"
    messages=[{"role": "user", "content": "Say hello from Ambient."}],
)
print(resp.choices[0].message.content)
Node (openai SDK)
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.ambient.xyz/v1",
  apiKey: process.env.AMBIENT_KEY, // create one at https://app.ambient.xyz/keys
});

const resp = await client.chat.completions.create({
  model: "zai-org/GLM-5.1-FP8",
  messages: [{ role: "user", content: "Say hello from Ambient." }],
});
console.log(resp.choices[0].message.content);
List available models
curl https://api.ambient.xyz/v1/models \
  -H "Authorization: Bearer $AMBIENT_KEY"

Use it from your agent of choice

Ambient Desktop

Built in. Sign in once and the included models are ready — nothing to configure. Start with the Quickstart.

Any OpenAI-compatible tool

Editors, agent frameworks, and SDKs that accept a custom OpenAI base URL just work: set the base URL to https://api.ambient.xyz/v1 and your Ambient key.

Zero data retention

Every request through this API is zero data retention by default. Prompts, context, and outputs are processed to serve the response and then discarded — only usage and billing metadata is kept. The guarantee is backed by both technical inspection and legally binding contracts. See Privacy & Data Retention for the full story.

Pay-per-use with x402

Beyond subscriptions, Ambient supports the x402 payment standard on Solana and Base, so agents can pay for inference per request. See the x402 client documentation for integration details.

FAQ

Is it really OpenAI-compatible?

Yes. It implements the standard Chat Completions API, so any OpenAI client works by pointing its base URL at https://api.ambient.xyz/v1 and using your Ambient key. The Anthropic Messages format is also supported.

Which models can I call?

GLM-5.1 FP8 (zai-org/GLM-5.1-FP8) and Kimi K2.7 Code (moonshotai/kimi-k2.7-code). Call GET /v1/models to list what is currently available.

Do you keep my prompts or responses?

No. The API is zero data retention by default; only usage and billing metadata is retained. See Privacy & Data Retention.

Where is the complete API reference?

The authoritative, always-current API reference lives at docs.ambient.xyz. This page is a quickstart for using Ambient inference from Ambient Desktop or your own agent.