diff --git a/README.md b/README.md index 824ad9e..61784cb 100644 --- a/README.md +++ b/README.md @@ -107,9 +107,16 @@ resp = client.chat.completions.create( Any OpenAI-compatible client works the same way: set the base URL to `https://gateway.inference.coop/v1` and the API key to your member key. -#### pi.dev (coding agent) +#### Coding agents and other OpenAI-compatible clients -pi.dev's `api` field selects the protocol. Use `openai-completions` (our gateway is an OpenAI-compatible chat-completions server), set `baseUrl` to the full `/v1` path, and `apiKey` to your member key: +Any client that speaks the OpenAI API works the same way. Where a tool asks for a provider/endpoint configuration: + +- **Base URL / endpoint:** `https://gateway.inference.coop/v1` +- **API type / protocol:** "OpenAI compatible" (or `openai-completions` where a protocol must be named) — not "Ollama", "Anthropic", or "Responses" +- **API key:** your member key (the `sk-…` string) +- **Model:** one of `deepseek-v4-1-flash`, `gpt-oss-120b`, `glm-5-3-flash` + +A typical JSON provider entry looks like: ```json { @@ -128,17 +135,7 @@ pi.dev's `api` field selects the protocol. Use `openai-completions` (our gateway } ``` -Note: pi.dev appends `/chat/completions` to `baseUrl` itself, so include the trailing `/v1` and do **not** add `/chat/completions`. - -#### Other OpenAI-compatible tools (Ollama-style, LibreChat, etc.) - -The general pattern is the same across tools that speak the OpenAI API: - -- **Base URL / endpoint:** `https://gateway.inference.coop/v1` -- **API type / protocol:** "OpenAI compatible" or `openai-completions` (not "Ollama", "Anthropic", or "Responses") -- **API key:** your member key (the `sk-…` string) - -If a tool's docs show an Ollama example with `baseUrl: http://localhost:11434/v1` and `api: "openai-completions"`, substitute our base URL and your member key for `apiKey` — the `api` value stays the same. +If a tool's own docs show a local-server example (e.g. `baseUrl: http://localhost:11434/v1` with `api: "openai-completions"`), substitute our base URL and your member key for `apiKey` — the protocol value stays the same. Some tools append `/chat/completions` to the base URL themselves; if your base URL already ends in `/v1`, that's correct and you should not add `/chat/completions`. ### Privacy