Commit 13ae047
docs: clarify BYOK + Custom Inference request path and data flow (#138)
* docs: clarify BYOK request path and data flow
The BYOK doc previously said keys are "stored locally" (true) and that
Warp "directly routes" requests to the provider (misleading — the Warp
Agent harness is server-hosted, so traffic does transit Warp's backend
while the key is used in-flight per request).
This commit:
- Replaces "directly route" language with an explicit 3-step data flow.
- Adds a "Why does the request route through Warp's backend?" note
explaining the server-side harness.
- Adds a sentence to the ZDR section noting BYOK request bodies are not
retained, used for training, or logged for analytics.
- Tightens the diagram alt text and intro paragraph to remove the same
"directly" ambiguity.
Co-Authored-By: Oz <oz-agent@warp.dev>
* Update src/content/docs/agent-platform/inference/bring-your-own-api-key.mdx
Co-authored-by: oz-for-oss[bot] <277970191+oz-for-oss[bot]@users.noreply.github.com>
* docs: generalize harness explanation in BYOK doc
Replace specific feature list (Codebase Context, Rules, Secret Redaction,
multi-step tool orchestration) with a more general 'Warp's agent harness'
reference. Keeps the explanation accurate without enumerating internals
that may evolve.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs: clarify Custom Inference endpoint request path and data flow
Issue #11681 reported that the privacy framing on the Custom Inference
endpoint page was misleading: requests are server-hosted through
warp-server, so traffic does transit Warp's backend even though the
endpoint URL and API key are stored locally on the client.
This commit narrows and corrects the privacy claim on the Custom
Inference endpoint page, mirroring the BYOK rewrite already in this PR:
- Replace the blanket 'never synced to the cloud' wording for endpoint
URLs with a narrower, accurate claim: API keys are never synced or
stored on Warp's servers; endpoint URLs and model identifiers may
appear in Warp's usage telemetry, but API keys never do.
- Add an explicit 3-step request flow (harness assembles -> in-flight
key authenticates the call -> response streams back) so the
server-side path is no longer surprising.
- Add a 'Why does the request route through Warp's backend?' callout
matching the BYOK page.
- Tighten the ZDR section to note that prompts/responses transit Warp's
backend without being used for training, and scope the existing
retention bullets to the provider side.
Also align the BYOK headline claim with the same wording ('never synced
or stored on Warp's servers') so both pages converge on a single
phrasing.
Confirmed against warp-server:
- logic/ai/llm/custom_endpoint/client.go:14-21 - the OpenAI-compatible
client is constructed server-side using
hostConfig.CustomEndpointAPIKey() and hostConfig.CustomEndpointBaseURL()
from the request, not from persistent server config.
- logic/ai/llm/user_api_keys/util.go:7 - keys arrive per-request via
Request_Settings_ApiKeys.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs: drop telemetry caveat from Custom Inference doc
Per review feedback, simplify the Custom Inference endpoint privacy
framing to a single durable claim — API keys are never synced or stored
on Warp's servers — without adding a separate caveat about endpoint
URL or model identifier telemetry.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs: soften BYOK / Custom Inference key-storage claim per review
Per Petra's review feedback: the previous phrasing 'stored locally on
your device and never synced or stored on Warp's servers' technically
holds but implies too strongly that the API key never leaves the
user's machine. The key does transit Warp's backend in-flight per
request (see the 3-step flow further down each page).
Reframe the headline storage claim on both pages to focus on what the
key is for instead of where it isn't: it is stored only on the user's
device and used to authenticate requests to the model provider /
configured endpoint. The downstream 3-step flow and 'Why does the
request route through Warp's backend?' callout remain unchanged and
continue to explain the actual transit path.
Co-Authored-By: Oz <oz-agent@warp.dev>
* docs: adopt Petra's plain-language framing for BYOK key handling
Per the remaining review feedback on PR #138:
- Replace 'stored only on your device' headline claim with explicit
language that the key passes through Warp's servers but is not
stored there, mirroring Petra's preferred phrasing.
- Reshuffle the 3-step flow so step 1 is local (client pulls the
key from secure storage and sends it up) and step 2 explicitly
states that the agent harness runs on Warp's backend, answering
Petra's question about where assembly happens.
- Reword the 'held in memory' sentence to use the same
'passes through but is not stored' framing.
Same changes applied in parallel to the Custom Inference Endpoint page.
Co-Authored-By: Oz <oz-agent@warp.dev>
---------
Co-authored-by: Oz <oz-agent@warp.dev>
Co-authored-by: oz-for-oss[bot] <277970191+oz-for-oss[bot]@users.noreply.github.com>1 parent e9c0980 commit 13ae047
2 files changed
Lines changed: 36 additions & 10 deletions
File tree
- src/content/docs/agent-platform/inference
Lines changed: 17 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
34 | | - | |
| 34 | + | |
35 | 35 | | |
36 | | - | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
37 | 47 | | |
38 | 48 | | |
39 | 49 | | |
| |||
45 | 55 | | |
46 | 56 | | |
47 | 57 | | |
48 | | - | |
| 58 | + | |
49 | 59 | | |
50 | 60 | | |
51 | 61 | | |
| |||
117 | 127 | | |
118 | 128 | | |
119 | 129 | | |
| 130 | + | |
| 131 | + | |
120 | 132 | | |
121 | 133 | | |
122 | | - | |
| 134 | + | |
123 | 135 | | |
124 | 136 | | |
125 | 137 | | |
| |||
Lines changed: 19 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
| 21 | + | |
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
32 | | - | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
33 | 45 | | |
34 | 46 | | |
35 | 47 | | |
| |||
39 | 51 | | |
40 | 52 | | |
41 | 53 | | |
42 | | - | |
| 54 | + | |
43 | 55 | | |
44 | 56 | | |
45 | 57 | | |
| |||
86 | 98 | | |
87 | 99 | | |
88 | 100 | | |
| 101 | + | |
| 102 | + | |
89 | 103 | | |
90 | 104 | | |
91 | | - | |
| 105 | + | |
92 | 106 | | |
93 | 107 | | |
94 | 108 | | |
95 | | - | |
| 109 | + | |
96 | 110 | | |
97 | 111 | | |
98 | 112 | | |
| |||
0 commit comments